Class Entry

protected byte[] payload

This entry's payload.

protected Properties properties

This entry's property set.

protected int type

This entry's type identifier.

protected Entry(int type)

Constructor for use by subclasses.

protected Entry(int type,
                Properties properties)

Creates a new Entry.

Parameters:

type - This entry's type.

properties - This entry's properties.

Throws:

IllegalArgumentException - If the properties argument is null, or if the type is out of range.

protected void defaultDecode(DataInputStream in)
            throws IOException

Generic decoding method, which simply decodes the properties field and reads the payload field.

Parameters:

in - The input data stream.

Throws:

IOException - If an I/O error occurs.

public void encode(DataOutputStream out)
            throws IOException

This method is called when this entry needs to be written to an output stream.

Parameters:

out - The stream to write to.

Throws:

IOException - If an I/O exception occurs.

protected abstract void encodePayload()
            throws IOException

This method is called of subclasses when the payload data needs to be created.

Throws:

IOException - If an encoding error occurs.

public byte[] getPayload()

Returns this entry's payload data, or null if

public Properties getProperties()

Returns this entry's properties object. The properties are cloned before being returned.

Returns:

The properties.

public String toString()

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:

toString in interface Object

Returns:

the String representing this Object, which may be null

See Also:

getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)