Package fr.dyade.aaa.common.encoding

Class EncodedString

java.lang.Object

fr.dyade.aaa.common.encoding.EncodedString

All Implemented Interfaces:

Encodable, Serializable

public final class EncodedString
extends Object
implements Serializable, Encodable

Encodable object that wraps a string. It also serves as a cache for the encoded string.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EncodedString.Factory

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	encodedString
private String	string

Fields inherited from interface fr.dyade.aaa.common.encoding.Encodable

BOOLEAN_ENCODED_SIZE, BYTE_ENCODED_SIZE, DOUBLE_ENCODED_SIZE, FLOAT_ENCODED_SIZE, INT_ENCODED_SIZE, LONG_ENCODED_SIZE, SHORT_ENCODED_SIZE

Constructor Summary

Constructors

Constructor	Description
EncodedString()
EncodedString(String string)

Method Summary

Modifier and Type	Method	Description
void	decode(Decoder decoder)	Decodes the content of this object
void	encode(Encoder encoder)	Encodes the content of this object
boolean	equals(Object obj)
int	getEncodableClassId()	Returns a unique class identifier.
int	getEncodedSize()	Returns the size of the byte array that results from the encoding of this object.
String	getString()
int	hashCode()
void	readFrom(DataInputStream is)
private void	readObject(ObjectInputStream in)
String	toString()
private void	writeObject(ObjectOutputStream out)
void	writeTo(DataOutputStream os)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

string

private String string

encodedString

private byte[] encodedString

Constructor Detail

EncodedString

public EncodedString()

EncodedString

public EncodedString(String string)

Method Detail

getString

public String getString()

writeTo

public void writeTo(DataOutputStream os)
             throws IOException

Throws:

IOException

readFrom

public void readFrom(DataInputStream is)
              throws IOException

Throws:

IOException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getEncodableClassId

public int getEncodableClassId()

Description copied from interface: Encodable

Returns a unique class identifier.

Specified by:

getEncodableClassId in interface Encodable

Returns:

a unique class identifier

getEncodedSize

public int getEncodedSize()

Description copied from interface: Encodable

Returns the size of the byte array that results from the encoding of this object.

Specified by:

getEncodedSize in interface Encodable

Returns:

the size of the encoded byte array

encode

public void encode(Encoder encoder)
            throws Exception

Description copied from interface: Encodable

Encodes the content of this object

Specified by:

encode in interface Encodable

Parameters:

encoder - the encoder to be used for the encoding

Throws:

Exception - if an error occurs

decode

public void decode(Decoder decoder)
            throws Exception

Description copied from interface: Encodable

Decodes the content of this object

Specified by:

decode in interface Encodable

Parameters:

decoder - the decoder to be used for the decoding

Throws:

Exception - if an error occurs