Module de.haumacher.msgbuf

Package de.haumacher.msgbuf.binary

Class OctetDataWriter

java.lang.Object

de.haumacher.msgbuf.binary.OctetDataWriter

All Implemented Interfaces:

DataWriter

public class OctetDataWriter
extends Object
implements DataWriter

DataWriter that encodes into a stream of octets (8 bit byte values).

Constructor Summary

Constructors

Constructor	Description
OctetDataWriter(OutputStream out)	Creates a OctetDataWriter.

Method Summary

Modifier and Type	Method	Description
void	beginArray(DataType type, int length)	Starts writing an array value with entries of the given type.
void	beginObject()	Starts writing an object.
void	endArray()	Stops writing the array started with the last call to DataWriter.beginObject().
void	endObject()	Finishes writing the fields of the object started with the last call to DataWriter.beginObject().
void	name(int id)	Writes an identifier of a field fo the currently written object.
void	value(byte[] value)	Writes a binary string value.
void	value(double value)	Writes a double value.
void	value(float value)	Writes a float value.
void	value(int value)	Writes an unsigned int value.
void	value(long value)	Writes an unsigned long value.
void	value(String value)	Writes a String value in utf-8 encoding.
OutputStream	valueBinaryStream()	Starts writing a binary value of arbitrary length in chunked mode.
void	valueFixed(int value)	Writes a fixed size 32 bit int value.
void	valueFixed(long value)	Writes a fixed size 64 bit long value.
void	valueSigned(int value)	Writes a signed int value.
void	valueSigned(long value)	Writes a signed long value.

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.DataWriter

value

Constructor Detail

OctetDataWriter

public OctetDataWriter(OutputStream out)

Creates a OctetDataWriter.

Method Detail

beginObject

public void beginObject()
                 throws IOException

Description copied from interface: DataWriter

Starts writing an object.

A sequence of interleaving calls to DataWriter.name(int) and a value encoding method such as DataWriter.value(int) is expected followed by a final DataWriter.endObject() call.

Specified by:

beginObject in interface DataWriter

Throws:

IOException - If writing fails.

endObject

public void endObject()
               throws IOException

Description copied from interface: DataWriter

Finishes writing the fields of the object started with the last call to DataWriter.beginObject().

Specified by:

endObject in interface DataWriter

Throws:

IOException - If writing fails.

beginArray

public void beginArray(DataType type,
                       int length)
                throws IOException

Description copied from interface: DataWriter

Starts writing an array value with entries of the given type.

Specified by:

beginArray in interface DataWriter

Parameters:

type - The type of the array elements.

length - The number of elements that follow.

Throws:

IOException - If writing fails.

endArray

public void endArray()
              throws IOException

Description copied from interface: DataWriter

Stops writing the array started with the last call to DataWriter.beginObject().

Specified by:

endArray in interface DataWriter

Throws:

IOException - If writing fails.

name

public void name(int id)
          throws IOException

Description copied from interface: DataWriter

Writes an identifier of a field fo the currently written object.

Specified by:

name in interface DataWriter

Throws:

IOException - If writing fails.

value

public void value(int value)
           throws IOException

Description copied from interface: DataWriter

Writes an unsigned int value.

Specified by:

value in interface DataWriter

Throws:

IOException - If writing fails.

valueSigned

public void valueSigned(int value)
                 throws IOException

Description copied from interface: DataWriter

Writes a signed int value.

Specified by:

valueSigned in interface DataWriter

Throws:

IOException - If writing fails.

valueFixed

public void valueFixed(int value)
                throws IOException

Description copied from interface: DataWriter

Writes a fixed size 32 bit int value.

Specified by:

valueFixed in interface DataWriter

Throws:

IOException - If writing fails.

value

public void value(float value)
           throws IOException

Description copied from interface: DataWriter

Writes a float value.

Specified by:

value in interface DataWriter

Throws:

IOException - If writing fails.

value

public void value(long value)
           throws IOException

Description copied from interface: DataWriter

Writes an unsigned long value.

Specified by:

value in interface DataWriter

Throws:

IOException - If writing fails.

valueSigned

public void valueSigned(long value)
                 throws IOException

Description copied from interface: DataWriter

Writes a signed long value.

Specified by:

valueSigned in interface DataWriter

Throws:

IOException - If writing fails.

valueFixed

public void valueFixed(long value)
                throws IOException

Description copied from interface: DataWriter

Writes a fixed size 64 bit long value.

Specified by:

valueFixed in interface DataWriter

Throws:

IOException - If writing fails.

value

public void value(double value)
           throws IOException

Description copied from interface: DataWriter

Writes a double value.

Specified by:

value in interface DataWriter

Throws:

IOException - If writing fails.

value

public void value(byte[] value)
           throws IOException

Description copied from interface: DataWriter

Writes a binary string value.

Specified by:

value in interface DataWriter

Throws:

IOException - If writing fails.

valueBinaryStream

public OutputStream valueBinaryStream()
                               throws IOException

Description copied from interface: DataWriter

Starts writing a binary value of arbitrary length in chunked mode.

The binary contents must be written the the resulting OutputStream. No other methods of this DataWriter must be called before the resulting OutputStream has been closed.

Specified by:

valueBinaryStream in interface DataWriter

Throws:

IOException - If writing fails.

value

public void value(String value)
           throws IOException

Description copied from interface: DataWriter

Writes a String value in utf-8 encoding.

Specified by:

value in interface DataWriter

Throws:

IOException - If writing fails.