com.solacesystems.jcsmp.impl.sdt

Class StreamImpl

java.lang.Object

com.solacesystems.jcsmp.impl.sdt.StreamImpl

All Implemented Interfaces:

SDTSerializable, SDTStreamIF, SDTStream

public class StreamImpl
extends Object
implements SDTStreamIF, SDTSerializable

Constructor Summary

Constructors

Constructor and Description
StreamImpl()
StreamImpl(int capacity)
StreamImpl(StreamTLVBuffer buffer) For Read-Only streams

Method Summary

Modifier and Type	Method and Description
ByteArray	asByteArray()
void	clear() Clears the current contents of the stream.
boolean	equals(Object obj)
long	getVersion()
int	hashCode()
boolean	hasRemaining() Returns true if there is more to be read on the stream.
void	mark() Marks the current read pointer for later use by reset().
Object	read() Reads the next object on the stream.
Boolean	readBoolean() Reads a Boolean from a Stream.
Byte	readByte() Reads a Byte from a Stream.
ByteArray	readByteArray()
byte[]	readBytes() Reads a byte[] from a Stream.
Character	readCharacter() Reads a Character from a Stream.
Destination	readDestination() Reads a Destination from a Stream.
Double	readDouble() Reads a Double from a Stream.
Float	readFloat() Reads a Float from a Stream.
Integer	readInteger() Reads an Integer from a Stream.
Long	readLong() Reads a Long from a Stream.
SDTMap	readMap() Reads a SDTMap from a Stream.
RawSMFMessage	readMessage() SolReserved - Reads a RawSMFMessage from a Stream.
Short	readShort() Reads a Short from a Stream.
SDTStream	readStream() Reads a SDTStream from a Stream.
String	readString() Reads a String from a Stream.
void	reset() Resets the read pointer to the last position saved by mark().
void	rewind() Rewinds the read pointer to the beginning of the stream.
void	serialize(TLVBuffer buffer)
void	setFormatter(Formatter fmter)
String	toString()
void	writeBoolean(Boolean value) Writes a Boolean to a stream.
void	writeByte(Byte value) Writes a Byte to a stream.
void	writeByteArray(ByteArray value)
void	writeBytes(byte[] value) Writes a byte[] to a stream.
void	writeBytes(byte[] value, int offset, int length) Writes a byte[] to a stream.
void	writeCharacter(Character value) Writes a Character to a stream.
void	writeDestination(Destination value) Writes a Destination to a stream.
void	writeDouble(Double value) Writes a Double to a stream.
void	writeFloat(Float value) Writes a Float to a stream.
void	writeInteger(Integer value) Writes an Integer to a stream.
void	writeLong(Long value) Writes a Long to a stream.
void	writeMap(SDTMap value) Writes a SDTMap to a stream.
void	writeMessage(RawSMFMessage value) SolReserved - Writes a RawSMFMessage to a stream.
void	writeObject(Object value) Writes an Object to a stream.
void	writeShort(Short value) Writes a Short to a stream.
void	writeStream(SDTStream value) Writes a SDTStream to a stream.
void	writeString(String value) Writes a String to a stream.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StreamImpl

public StreamImpl()

StreamImpl

public StreamImpl(int capacity)

StreamImpl

public StreamImpl(StreamTLVBuffer buffer)

For Read-Only streams

Parameters:

buffer - parameter

Method Detail

serialize

public void serialize(TLVBuffer buffer)

Specified by:

serialize in interface SDTSerializable

getVersion

public long getVersion()

setFormatter

public void setFormatter(Formatter fmter)

Specified by:

setFormatter in interface SDTStreamIF

clear

public void clear()

Description copied from interface: SDTStream

Clears the current contents of the stream. Resets the read and write pointer to the beginning of the stream.

Specified by:

clear in interface SDTStream

asByteArray

public ByteArray asByteArray()

Specified by:

asByteArray in interface SDTStreamIF

mark

public void mark()

Description copied from interface: SDTStream

Marks the current read pointer for later use by reset().

Specified by:

mark in interface SDTStream

reset

public void reset()

Description copied from interface: SDTStream

Resets the read pointer to the last position saved by mark().

Specified by:

reset in interface SDTStream

rewind

public void rewind()

Description copied from interface: SDTStream

Rewinds the read pointer to the beginning of the stream.

Specified by:

rewind in interface SDTStream

hasRemaining

public boolean hasRemaining()

Description copied from interface: SDTStream

Returns true if there is more to be read on the stream.

Specified by:

hasRemaining in interface SDTStream

Returns:

True if there is more to be read on the stream.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

read

public Object read()
            throws SDTException

Description copied from interface: SDTStream

Reads the next object on the stream.

Specified by:

read in interface SDTStream

Returns:

The next object on the stream. This can be null.

Throws:

SDTException - If unable to read a value because of some internal reason.

SDTEOFException - If unable to read because end of stream reached.

readBoolean

public Boolean readBoolean()
                    throws SDTException

Description copied from interface: SDTStream

Reads a Boolean from a Stream.

Specified by:

readBoolean in interface SDTStream

Returns:

Boolean value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - if this type conversion is invalid.

readByte

public Byte readByte()
              throws SDTException

Description copied from interface: SDTStream

Reads a Byte from a Stream.

Specified by:

readByte in interface SDTStream

Returns:

Byte value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readBytes

public byte[] readBytes()
                 throws SDTException

Description copied from interface: SDTStream

Reads a byte[] from a Stream.

Specified by:

readBytes in interface SDTStream

Returns:

byte[] value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readByteArray

public ByteArray readByteArray()
                        throws SDTException

Specified by:

readByteArray in interface SDTStream

Throws:

SDTException

readCharacter

public Character readCharacter()
                        throws SDTException

Description copied from interface: SDTStream

Reads a Character from a Stream.

Specified by:

readCharacter in interface SDTStream

Returns:

Character value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readDestination

public Destination readDestination()
                            throws SDTException

Description copied from interface: SDTStream

Reads a Destination from a Stream.

Specified by:

readDestination in interface SDTStream

Returns:

Destination value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readDouble

public Double readDouble()
                  throws SDTException

Description copied from interface: SDTStream

Reads a Double from a Stream.

Specified by:

readDouble in interface SDTStream

Returns:

Double value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readFloat

public Float readFloat()
                throws SDTException

Description copied from interface: SDTStream

Reads a Float from a Stream.

Specified by:

readFloat in interface SDTStream

Returns:

Float value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readInteger

public Integer readInteger()
                    throws SDTException

Description copied from interface: SDTStream

Reads an Integer from a Stream.

Specified by:

readInteger in interface SDTStream

Returns:

Integer value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readLong

public Long readLong()
              throws SDTException

Description copied from interface: SDTStream

Reads a Long from a Stream.

Specified by:

readLong in interface SDTStream

Returns:

Long value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readMap

public SDTMap readMap()
               throws SDTException

Description copied from interface: SDTStream

Reads a SDTMap from a Stream.

Specified by:

readMap in interface SDTStream

Returns:

SDTMap value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readMessage

public RawSMFMessage readMessage()
                          throws SDTException

Description copied from interface: SDTStream

SolReserved - Reads a RawSMFMessage from a Stream.

Specified by:

readMessage in interface SDTStream

Returns:

RawSMFMessage value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readShort

public Short readShort()
                throws SDTException

Description copied from interface: SDTStream

Reads a Short from a Stream.

Specified by:

readShort in interface SDTStream

Returns:

Short value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readStream

public SDTStream readStream()
                     throws SDTException

Description copied from interface: SDTStream

Reads a SDTStream from a Stream.

Specified by:

readStream in interface SDTStream

Returns:

SDTStream value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

readString

public String readString()
                  throws SDTException

Description copied from interface: SDTStream

Reads a String from a Stream.

Specified by:

readString in interface SDTStream

Returns:

String value from the stream or null.

Throws:

SDTException - If unable to read a value due to some internal reason.

SDTEOFException - If unable to read because end of stream reached.

SDTFormatException - If this type conversion is invalid.

writeBoolean

public void writeBoolean(Boolean value)

Description copied from interface: SDTStream

Writes a Boolean to a stream.

Specified by:

writeBoolean in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeByte

public void writeByte(Byte value)

Description copied from interface: SDTStream

Writes a Byte to a stream.

Specified by:

writeByte in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeBytes

public void writeBytes(byte[] value)

Description copied from interface: SDTStream

Writes a byte[] to a stream.

Specified by:

writeBytes in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeBytes

public void writeBytes(byte[] value,
                       int offset,
                       int length)

Description copied from interface: SDTStream

Writes a byte[] to a stream.

Specified by:

writeBytes in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeByteArray

public void writeByteArray(ByteArray value)

Specified by:

writeByteArray in interface SDTStream

writeCharacter

public void writeCharacter(Character value)

Description copied from interface: SDTStream

Writes a Character to a stream.

Specified by:

writeCharacter in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeDestination

public void writeDestination(Destination value)

Description copied from interface: SDTStream

Writes a Destination to a stream.

Specified by:

writeDestination in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeDouble

public void writeDouble(Double value)

Description copied from interface: SDTStream

Writes a Double to a stream.

Specified by:

writeDouble in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeFloat

public void writeFloat(Float value)

Description copied from interface: SDTStream

Writes a Float to a stream.

Specified by:

writeFloat in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeInteger

public void writeInteger(Integer value)

Description copied from interface: SDTStream

Writes an Integer to a stream.

Specified by:

writeInteger in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeLong

public void writeLong(Long value)

Description copied from interface: SDTStream

Writes a Long to a stream.

Specified by:

writeLong in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeMap

public void writeMap(SDTMap value)

Description copied from interface: SDTStream

Writes a SDTMap to a stream. A copy of the SDTMap is made when writing it to the stream, so any changes made to the original SDTMap are not reflected in the stream.

Specified by:

writeMap in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeMessage

public void writeMessage(RawSMFMessage value)

Description copied from interface: SDTStream

SolReserved - Writes a RawSMFMessage to a stream.

Specified by:

writeMessage in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeObject

public void writeObject(Object value)

Description copied from interface: SDTStream

Writes an Object to a stream. Will throw an IllegalArgumentException if the Object argument is not one of the supported data types.

Specified by:

writeObject in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeShort

public void writeShort(Short value)

Description copied from interface: SDTStream

Writes a Short to a stream.

Specified by:

writeShort in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeStream

public void writeStream(SDTStream value)

Description copied from interface: SDTStream

Writes a SDTStream to a stream.

Specified by:

writeStream in interface SDTStream

Parameters:

value - The value to write. This can be null.

writeString

public void writeString(String value)

Description copied from interface: SDTStream

Writes a String to a stream.

Specified by:

writeString in interface SDTStream

Parameters:

value - The value to write. This can be null.

toString

public String toString()

Overrides:

toString in class Object