org.gatein.pc.api

Class StateString

java.lang.Object

org.gatein.pc.api.StateString

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OpaqueStateString, ParametersStateString

public abstract class StateString
extends Object
implements Serializable

Encapsulate state as a string.

Version:

$Revision: 5448 $

Author:

Julien Viet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	EMPTY
static String	JBPNS_PREFIX .
protected static int	OPAQUE
protected static int	SERIALIZED

Constructor Summary

Constructors

Constructor and Description
StateString()

Method Summary

Methods

Modifier and Type	Method and Description
static StateString	create(DataInputStream in) Factory method that will create the most appropriate form from the byte representation.
static StateString	create(String opaqueValue) Factory method that will create the most appropriate form from the string representation.
static Map<String,String[]>	decodeOpaqueValue(String opaqueValue)
static String	encodeAsOpaqueValue(Map<String,String[]> parameters)
abstract String	getStringValue() Return the value of the navigational state of the portlet.
abstract void	writeTo(DataOutputStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JBPNS_PREFIX

public static final String JBPNS_PREFIX

.

See Also:

Constant Field Values

EMPTY

protected static final int EMPTY

See Also:

Constant Field Values

SERIALIZED

protected static final int SERIALIZED

See Also:

Constant Field Values

OPAQUE

protected static final int OPAQUE

See Also:

Constant Field Values

Constructor Detail

StateString

public StateString()

Method Detail

getStringValue

public abstract String getStringValue()

Return the value of the navigational state of the portlet.

Returns:

the string value

writeTo

public abstract void writeTo(DataOutputStream out)
                      throws IOException

Throws:

IOException

create

public static StateString create(DataInputStream in)
                          throws IOException

Factory method that will create the most appropriate form from the byte representation.

Parameters:

in - the inputstream to read from

Returns:

a new state string

Throws:

IOException - any IOException

create

public static StateString create(String opaqueValue)

Factory method that will create the most appropriate form from the string representation.

Parameters:

opaqueValue - the opaque value

Returns:

a new state string

decodeOpaqueValue

public static Map<String,String[]> decodeOpaqueValue(String opaqueValue)

encodeAsOpaqueValue

public static String encodeAsOpaqueValue(Map<String,String[]> parameters)