ds.funnel.data.msglink.protocol3

Class MessageFormat

java.lang.Object

ds.funnel.data.msglink.protocol3.MessageFormat

All Implemented Interfaces:

FormatReader, FormatWriter

public class MessageFormat
extends java.lang.Object
implements FormatReader, FormatWriter

MessageOutput.java: Supplies methods to write data to a buffer.

Author:

Ryan Stern

Constructor Summary

Constructors

Constructor and Description
MessageFormat() Creates a new MessageOutput object.
MessageFormat(byte[] inBytes)
MessageFormat(StreamBuffer inBuffer)

Method Summary

Modifier and Type	Method and Description
StreamBuffer	getBuffer()
int	getLength()
boolean	readBool()
byte	readByte()
byte[]	readBytes()
double	readDouble()
<T extends java.lang.Enum<T>> T	readEnum(java.lang.Class<T> type)
float	readFloat()
int	readInt()
long	readLong()
<T> T	readObject(FormatUnmarshaller<T> type)
java.lang.Object	readObjectMarshalled()
java.lang.Object	readObjectSerialized()
short	readShort()
java.lang.String	readString()
byte[]	toByteArray() Copy the internal buffers into a new byte array.
java.lang.String	toString()
void	writeBool(boolean val) Writes a boolean to the underlying buffer.
void	writeByte(byte val) Writes a byte to the underlying buffer.
void	writeBytes(byte[] val) Writes a byte array to the underlying buffer.
void	writeBytesNoCopy(byte[] val) Write the bytes to the final buffer.
void	writeDouble(double val) Writes a double to the underlying buffer.
<T extends java.lang.Enum<T>> void	writeEnum(T val) Writes an enum to the underlying buffer.
void	writeFloat(float val) Writes a float to the underlying buffer.
void	writeInt(int val) Writes an integer to the underlying buffer.
void	writeLong(long val) Writes a long to the underlying buffer.
<T extends FormatMarshaller> void	writeObject(T val) Writes an object to the underlying buffer.
void	writeObjectMarshalled(java.lang.Object val) Writes an object to the underlying buffer using an object marshaller.
void	writeObjectSerialized(java.io.Serializable val) Writes an object to the underlying buffer by serializing it.
void	writeShort(short val) Writes a short to the underlying buffer.
void	writeString(java.lang.String val) Writes a string to the underlying buffer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageFormat

public MessageFormat()

Creates a new MessageOutput object.

MessageFormat

public MessageFormat(byte[] inBytes)

MessageFormat

public MessageFormat(StreamBuffer inBuffer)

Method Detail

toByteArray

public byte[] toByteArray()

Description copied from interface: FormatWriter

Copy the internal buffers into a new byte array.

Specified by:

toByteArray in interface FormatWriter

Returns:

A new byte array containing the written data.

getLength

public int getLength()

Returns:

The size of this message.

getBuffer

public StreamBuffer getBuffer()

Returns:

The buffer being written to.

writeBool

public void writeBool(boolean val)
               throws FormatException

Description copied from interface: FormatWriter

Writes a boolean to the underlying buffer.

Specified by:

writeBool in interface FormatWriter

Parameters:

val - - The boolean to write.

Throws:

FormatException - If there was a problem while writing.

readBool

public boolean readBool()
                 throws FormatException

Specified by:

readBool in interface FormatReader

Returns:

Reads a boolean from the underlying buffer.

Throws:

FormatException

writeByte

public void writeByte(byte val)
               throws FormatException

Description copied from interface: FormatWriter

Writes a byte to the underlying buffer.

Specified by:

writeByte in interface FormatWriter

Parameters:

val - - The short to write.

Throws:

FormatException - If there was a problem while writing.

readByte

public byte readByte()
              throws FormatException

Specified by:

readByte in interface FormatReader

Returns:

Reads a byte from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeShort

public void writeShort(short val)
                throws FormatException

Description copied from interface: FormatWriter

Writes a short to the underlying buffer.

Specified by:

writeShort in interface FormatWriter

Parameters:

val - - The short to write.

Throws:

FormatException - If there was a problem while writing.

readShort

public short readShort()
                throws FormatException

Specified by:

readShort in interface FormatReader

Returns:

Reads a short from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeInt

public void writeInt(int val)
              throws FormatException

Description copied from interface: FormatWriter

Writes an integer to the underlying buffer.

Specified by:

writeInt in interface FormatWriter

Parameters:

val - - The integer to write.

Throws:

FormatException - If there was a problem while writing.

readInt

public int readInt()
            throws FormatException

Specified by:

readInt in interface FormatReader

Returns:

Reads an integer from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeLong

public void writeLong(long val)
               throws FormatException

Description copied from interface: FormatWriter

Writes a long to the underlying buffer.

Specified by:

writeLong in interface FormatWriter

Parameters:

val - - The double to write.

Throws:

FormatException - If there was a problem while writing.

readLong

public long readLong()
              throws FormatException

Specified by:

readLong in interface FormatReader

Returns:

Reads a long from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeFloat

public void writeFloat(float val)

Description copied from interface: FormatWriter

Writes a float to the underlying buffer.

Specified by:

writeFloat in interface FormatWriter

Parameters:

val - - the float to write.

readFloat

public float readFloat()

Specified by:

readFloat in interface FormatReader

Returns:

writeDouble

public void writeDouble(double val)
                 throws FormatException

Description copied from interface: FormatWriter

Writes a double to the underlying buffer.

Specified by:

writeDouble in interface FormatWriter

Parameters:

val - - The double to write.

Throws:

FormatException - If there was a problem while writing.

readDouble

public double readDouble()
                  throws FormatException

Specified by:

readDouble in interface FormatReader

Returns:

Reads a double from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeString

public void writeString(java.lang.String val)
                 throws FormatException

Description copied from interface: FormatWriter

Writes a string to the underlying buffer.

Specified by:

writeString in interface FormatWriter

Parameters:

val - - The string to write.

Throws:

FormatException - If there was a problem while writing.

readString

public java.lang.String readString()
                            throws FormatException

Specified by:

readString in interface FormatReader

Returns:

Reads a string from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeBytes

public void writeBytes(byte[] val)
                throws FormatException

Description copied from interface: FormatWriter

Writes a byte array to the underlying buffer.

Specified by:

writeBytes in interface FormatWriter

Parameters:

val - - The byte array to write.

Throws:

FormatException - If there was a problem while writing.

writeBytesNoCopy

public void writeBytesNoCopy(byte[] val)
                      throws FormatException

Description copied from interface: FormatWriter

Write the bytes to the final buffer. Holds a reference to the passed byte array.

Specified by:

writeBytesNoCopy in interface FormatWriter

Parameters:

val - - The byte array to write.

Throws:

FormatException - If there was a problem while writing.

readBytes

public byte[] readBytes()
                 throws FormatException

Specified by:

readBytes in interface FormatReader

Returns:

Reads a byte array from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeEnum

public <T extends java.lang.Enum<T>> void writeEnum(T val)
                                             throws FormatException

Description copied from interface: FormatWriter

Writes an enum to the underlying buffer.

Specified by:

writeEnum in interface FormatWriter

Parameters:

val - - The enum to write.

Throws:

FormatException - If there was a problem while writing.

readEnum

public <T extends java.lang.Enum<T>> T readEnum(java.lang.Class<T> type)
                                         throws FormatException

Specified by:

readEnum in interface FormatReader

Parameters:

type - The enum type;

Returns:

Reads an enum from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeObject

public <T extends FormatMarshaller> void writeObject(T val)
                                              throws FormatException

Description copied from interface: FormatWriter

Writes an object to the underlying buffer.

Specified by:

writeObject in interface FormatWriter

Parameters:

val - - The object to write.

Throws:

FormatException - If there was a problem while writing.

readObject

public <T> T readObject(FormatUnmarshaller<T> type)
                 throws FormatException

Specified by:

readObject in interface FormatReader

Returns:

Reads an object from the underlying buffer.

Throws:

FormatException - If there was a problem while reading.

writeObjectMarshalled

public void writeObjectMarshalled(java.lang.Object val)
                           throws FormatException

Description copied from interface: FormatWriter

Writes an object to the underlying buffer using an object marshaller.

Specified by:

writeObjectMarshalled in interface FormatWriter

Parameters:

val - - The object to write.

Throws:

FormatException - If there was a problem while writing.

readObjectMarshalled

public java.lang.Object readObjectMarshalled()
                                      throws FormatException

Specified by:

readObjectMarshalled in interface FormatReader

Returns:

Reads an object from the underlying buffer using an unmarshaller.

Throws:

FormatException - If there was a problem while reading.

writeObjectSerialized

public void writeObjectSerialized(java.io.Serializable val)
                           throws FormatException

Description copied from interface: FormatWriter

Writes an object to the underlying buffer by serializing it.

Specified by:

writeObjectSerialized in interface FormatWriter

Parameters:

val - - The object to write.

Throws:

FormatException - If there was a problem while writing.

readObjectSerialized

public java.lang.Object readObjectSerialized()
                                      throws FormatException

Specified by:

readObjectSerialized in interface FormatReader

Returns:

Reads an object from the underlying buffer by deserializing it.

Throws:

FormatException - If there was a problem while reading.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object