SDTStream (Solace Messaging API for Java v10.25.1)

public interface SDTStream

Stream Structured Data Type (SDT) that supports the following data types:

For values written as the row type, they can be read as the column type according to the following table.

 |        | boolean byte byte[] char dest double float int long Map  short Stream String 
 |--------------------------------------------------------------------------------------
 |boolean |    X                                                                    X
 |byte    |          X                                  X   X          X            X
 |byte[]  |                X
 |char    |                      X                                                  X
 |dest    |                           X
 |double  |                                 X                                       X
 |float   |                                 X      X                                X
 |int     |          X                                  X   X          X            X
 |long    |          X                                  X   X          X            X
 |Map     |                                                      X
 |SMFMsg  |                                                         
 |short   |          X                                  X   X          X            X
 |Stream  |                                                                  X
 |String  |    X     X                      X      X    X   X          X            X 
 |--------------------------------------------------------------------------------------

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the current contents of the stream.
`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.
`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.
`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`	`writeBoolean(Boolean value)` Writes a Boolean to a stream.
`void`	`writeByte(Byte value)` Writes a Byte to a stream.
`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`	`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.

- Method Detail
  - clear
```
void clear()
```
    Clears the current contents of the stream. Resets the read and write pointer to the beginning of the stream.
  - read
```
Object read()
     throws SDTException
```
    Reads the next object on the stream.
    
    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
```
Boolean readBoolean()
             throws SDTException
```
    Reads a Boolean from a Stream.
    
    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
```
Byte readByte()
       throws SDTException
```
    Reads a Byte from a Stream.
    
    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
```
byte[] readBytes()
          throws SDTException
```
    Reads a byte[] from a Stream.
    
    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.
  - readCharacter
```
Character readCharacter()
                 throws SDTException
```
    Reads a Character from a Stream.
    
    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
```
Destination readDestination()
                     throws SDTException
```
    Reads a Destination from a Stream.
    
    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
```
Double readDouble()
           throws SDTException
```
    Reads a Double from a Stream.
    
    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
```
Float readFloat()
         throws SDTException
```
    Reads a Float from a Stream.
    
    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
```
Integer readInteger()
             throws SDTException
```
    Reads an Integer from a Stream.
    
    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
```
Long readLong()
       throws SDTException
```
    Reads a Long from a Stream.
    
    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
```
SDTMap readMap()
        throws SDTException
```
    Reads a SDTMap from a Stream.
    
    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.
  - readShort
```
Short readShort()
         throws SDTException
```
    Reads a Short from a Stream.
    
    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
```
SDTStream readStream()
              throws SDTException
```
    Reads a SDTStream from a Stream.
    
    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
```
String readString()
           throws SDTException
```
    Reads a String from a Stream.
    
    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.
  - mark
```
void mark()
```
    Marks the current read pointer for later use by reset().
  - reset
```
void reset()
```
    Resets the read pointer to the last position saved by mark().
  - rewind
```
void rewind()
```
    Rewinds the read pointer to the beginning of the stream.
  - hasRemaining
```
boolean hasRemaining()
```
    Returns true if there is more to be read on the stream.
    
    Returns:
    
    True if there is more to be read on the stream.
  - writeBoolean
```
void writeBoolean(Boolean value)
```
    Writes a Boolean to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeByte
```
void writeByte(Byte value)
```
    Writes a Byte to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeBytes
```
void writeBytes(byte[] value)
```
    Writes a byte[] to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeBytes
```
void writeBytes(byte[] value,
                int offset,
                int length)
```
    Writes a byte[] to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeCharacter
```
void writeCharacter(Character value)
```
    Writes a Character to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeDestination
```
void writeDestination(Destination value)
```
    Writes a Destination to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeDouble
```
void writeDouble(Double value)
```
    Writes a Double to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeFloat
```
void writeFloat(Float value)
```
    Writes a Float to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeInteger
```
void writeInteger(Integer value)
```
    Writes an Integer to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeLong
```
void writeLong(Long value)
```
    Writes a Long to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeMap
```
void writeMap(SDTMap value)
```
    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.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeShort
```
void writeShort(Short value)
```
    Writes a Short to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeStream
```
void writeStream(SDTStream value)
```
    Writes a SDTStream to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeString
```
void writeString(String value)
```
    Writes a String to a stream.
    
    Parameters:
    
    value - The value to write. This can be null.
  - writeObject
```
void writeObject(Object value)
```
    Writes an Object to a stream. Will throw an IllegalArgumentException if the Object argument is not one of the supported data types.
    
    Parameters:
    
    value - The value to write. This can be null.

Interface SDTStream

Method Summary

Method Detail

clear

read

readBoolean

readByte

readBytes

readCharacter

readDestination

readDouble

readFloat

readInteger

readLong

readMap

readShort

readStream

readString

mark

reset

rewind

hasRemaining

writeBoolean

writeByte

writeBytes

writeBytes

writeCharacter

writeDestination

writeDouble

writeFloat

writeInteger

writeLong

writeMap

writeShort

writeStream

writeString

writeObject