Method Detail

• getMessage

  DataMessage getMessage()

  Deprecated. 
  Returns the message that this reader is for.

  Returns:

  the message.

• nextByte

  byte nextByte()
         throws MessageException

  Deprecated. 
  Returns the next byte of data from the message.

  The byte of data at the current position is returned and the position updated.

  Returns:

  the next byte of data.

  Throws:

  MessageException - if unable to return the next byte of data.

• nextBytes

  void nextBytes(byte[] destination)
          throws MessageException

  Deprecated. 
  Returns data from the message as bytes from the current position.

  Bytes from current message position are transferred into the specified destination array until the destination array is filled. The message position is then updated.

  Parameters:

  destination - the destination array.

  Throws:

  MessageException - if the destination array is too long.

• nextRecord

  Record nextRecord()
             throws MessageException

  Deprecated. 
  Returns a record of string data from the current message position.

  This returns a record of String data read from the current data buffer position to the next record delimiter within the buffer or the end of the message.

  Fields (areas delimited by field delimiters) are unpacked from within the record area. If there are no field delimiters then the returned record will contain only one field.

  hasRemaining() should be called before calling this method to determine whether there is any data to read.

  After calling this method the data buffer position will be moved beyond the record read.

  Returns:

  the next record or null if there is no more data in the data buffer (hasRemaining() is false).

  Throws:

  MessageException - if unable to obtain the next record.

• nextField

  String nextField()
            throws MessageException

  Deprecated. 
  Returns a field of string data from the current message position.

  This returns a field of String data constructed from bytes read from the current data buffer position to the next field delimiter (or record delimiter) within the buffer or the end of the message.

  hasRemaining() should be called before calling this method to determine whether there is any data to read.

  After calling this method the data buffer pointer will be moved beyond the delimiter found.

  Returns:

  the next field or null if there is no more data in the data buffer (hasRemaining() is false).

  Throws:

  MessageException - if unable to read the next field from the record.

• rewind

  void rewind()

  Deprecated. 
  Resets the data pointer to the start of the data in preparation for relative read ('next...') operations.

• hasRemaining

  boolean hasRemaining()

  Deprecated. 
  Indicates whether the message has any remaining data to read.

  Returns:

  true if the current message pointer is less than the message data size.

• remaining

  int remaining()

  Deprecated. 
  Indicates the number of unread data bytes remaining within the message.

  Returns:

  the number of bytes between the current message pointer and the end of the data.