Module de.haumacher.msgbuf

Package de.haumacher.msgbuf.binary

Class OctetDataReader

java.lang.Object

de.haumacher.msgbuf.binary.OctetDataReader

All Implemented Interfaces:

DataReader

public class OctetDataReader
extends Object
implements DataReader

DataReader that reconstructs values written with a OctetDataWriter.

Constructor Summary

Constructors

Constructor	Description
OctetDataReader(InputStream in)	Creates a OctetDataReader.

Method Summary

Modifier and Type	Method	Description
int	beginArray()	Starts reading an array.
void	beginObject()	Starts reading an object.
void	endArray()	Finishes reading the array started with DataReader.beginArray().
void	endObject()	Finishes reading the object started with the last call to DataReader.beginObject().
boolean	hasNext()	When reading an object or array, whether there are more fields or array elements left to read.
byte[]	nextBinary()	Reads a binary string value.
InputStream	nextBinaryStream()	Reads a binary stream value.
double	nextDouble()	Reads a 64 bit double value.
float	nextFloat()	Reads a 32 bit float value.
int	nextInt()	Reads an (unsigned) integer value.
int	nextIntFixed()	Reads a full 32 bit integer value.
int	nextIntSigned()	Reads a signed integer value.
long	nextLong()	Reads an (unsigned) long value.
long	nextLongFixed()	Reads a full 64 bit long value.
long	nextLongSigned()	Reads a signed long value.
int	nextName()	When reading an object, retrieves the next field identifier.
String	nextString()	Reads an utf-8 String value.
void	skipValue()	Skips the current value to read.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.haumacher.msgbuf.binary.DataReader

nextBoolean

Constructor Detail

OctetDataReader

public OctetDataReader(InputStream in)

Creates a OctetDataReader.

Method Detail

beginObject

public void beginObject()
                 throws IOException

Description copied from interface: DataReader

Starts reading an object.

After this call, an alternating sequence of calls to DataReader.nextName() followed by a value retrieval method such as DataReader.nextInt(),... DataReader.nextString() followed by a final call to DataReader.endObject() is expected.

Specified by:

beginObject in interface DataReader

Throws:

IOException - If reading fails.

endObject

public void endObject()
               throws IOException

Description copied from interface: DataReader

Finishes reading the object started with the last call to DataReader.beginObject().

Specified by:

endObject in interface DataReader

Throws:

IOException - If reading fails.

hasNext

public boolean hasNext()
                throws IOException

Description copied from interface: DataReader

When reading an object or array, whether there are more fields or array elements left to read.

Specified by:

hasNext in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextName

public int nextName()
             throws IOException

Description copied from interface: DataReader

When reading an object, retrieves the next field identifier.

Note: DataReader.hasNext() must return true to be able to read the next field identifier.

Specified by:

nextName in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextInt

public int nextInt()
            throws IOException

Description copied from interface: DataReader

Reads an (unsigned) integer value.

Specified by:

nextInt in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextIntSigned

public int nextIntSigned()
                  throws IOException

Description copied from interface: DataReader

Reads a signed integer value.

Specified by:

nextIntSigned in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextIntFixed

public int nextIntFixed()
                 throws IOException

Description copied from interface: DataReader

Reads a full 32 bit integer value.

Specified by:

nextIntFixed in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextLong

public long nextLong()
              throws IOException

Description copied from interface: DataReader

Reads an (unsigned) long value.

Specified by:

nextLong in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextLongSigned

public long nextLongSigned()
                    throws IOException

Description copied from interface: DataReader

Reads a signed long value.

Specified by:

nextLongSigned in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextLongFixed

public long nextLongFixed()
                   throws IOException

Description copied from interface: DataReader

Reads a full 64 bit long value.

Specified by:

nextLongFixed in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextFloat

public float nextFloat()
                throws IOException

Description copied from interface: DataReader

Reads a 32 bit float value.

Specified by:

nextFloat in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextDouble

public double nextDouble()
                  throws IOException

Description copied from interface: DataReader

Reads a 64 bit double value.

Specified by:

nextDouble in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextString

public String nextString()
                  throws IOException

Description copied from interface: DataReader

Reads an utf-8 String value.

Specified by:

nextString in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextBinary

public byte[] nextBinary()
                  throws IOException

Description copied from interface: DataReader

Reads a binary string value.

The value might have been produced by DataWriter.value(byte[]), or DataWriter.valueBinaryStream(). Best efficiency is achieved, if a value produced with DataWriter.valueBinaryStream() is read by DataReader.nextBinaryStream().

Specified by:

nextBinary in interface DataReader

Returns:

The retrieved value.

Throws:

IOException - If reading fails.

nextBinaryStream

public InputStream nextBinaryStream()
                             throws IOException

Description copied from interface: DataReader

Reads a binary stream value.

The value might have been produced by DataWriter.value(byte[]), or DataWriter.valueBinaryStream(). Best efficiency is achieved, if a value produced with DataWriter.valueBinaryStream() is read by DataReader.nextBinaryStream().

Specified by:

nextBinaryStream in interface DataReader

Returns:

The retrieved value as stream.

Throws:

IOException - If reading fails.

beginArray

public int beginArray()
               throws IOException

Description copied from interface: DataReader

Starts reading an array.

Specified by:

beginArray in interface DataReader

Returns:

The number of array elements to read.

Throws:

IOException - If reading fails.

endArray

public void endArray()
              throws IOException

Description copied from interface: DataReader

Finishes reading the array started with DataReader.beginArray().

Specified by:

endArray in interface DataReader

Throws:

IOException - If reading fails.

skipValue

public void skipValue()
               throws IOException

Description copied from interface: DataReader

Skips the current value to read.

Specified by:

skipValue in interface DataReader

Throws:

IOException - If reading fails.