net.named_data.jndn.encoding

Class BinaryXmlEncoder

java.lang.Object

net.named_data.jndn.encoding.BinaryXmlEncoder

public class BinaryXmlEncoder
extends Object

A BinaryXmlEncoder holds an output buffer and has methods to output Binary XML.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENCODING_LIMIT_1_BYTE
static int	ENCODING_LIMIT_2_BYTES
static int	ENCODING_LIMIT_3_BYTES

Constructor Summary

Constructors

Constructor and Description
BinaryXmlEncoder() Create a new BinaryXmlEncoder with a default DynamicByteBuffer for the output buffer.
BinaryXmlEncoder(int initialCapacity) Create a new BinaryXmlEncoder to use a DynamicByteBuffer with the initialCapacity.

Method Summary

Methods

Modifier and Type	Method and Description
int	getOffset() Get the current offset where the next data will be written in the output buffer.
ByteBuffer	getOutput() Return a slice of the output buffer up to the current position.
void	writeAbsDoubleBigEndianBlob(double value)
void	writeBlob(Blob value) Write a BLOB header, then the bytes of the blob value to the output buffer.
void	writeBlobDTagElement(int tag, Blob value) Write an element start header using DTAG with the tag to the output buffer, then the blob, then an element close.
void	writeElementClose() Write an element close to the output buffer.
void	writeElementStartDTag(int tag) Write an element start header using DTAG with the tag to the output buffer.
void	writeOptionalBlobDTagElement(int tag, Blob value) If value.buf() is null or value.size() is 0 then do nothing, otherwise call writeBlobDTagElement.
void	writeOptionalTimeMillisecondsDTagElement(int tag, double milliseconds) If milliseconds is negative then do nothing, otherwise call writeTimeMillisecondsDTagElement.
void	writeOptionalUDataDTagElement(int tag, Blob value) If value.buf() is null or value.size() is 0 then do nothing, otherwise call writeUDataDTagElement.
void	writeOptionalUnsignedDecimalIntDTagElement(int tag, int value) If value is negative then do nothing, otherwise call writeUnsignedDecimalIntDTagElement.
void	writeTimeMillisecondsDTagElement(int tag, double milliseconds) Write an element start header using DTAG with the tag to the output buffer, then the absolute value of milliseconds as a big endian BLOB converted to 4096 ticks per second, then an element close.
void	writeUData(Blob value) Write a UDATA header, then the bytes of the UDATA value to the output buffer.
void	writeUDataDTagElement(int tag, Blob value) Write an element start header using DTAG with the tag to the output buffer, then the UDATA value, then an element close.
void	writeUnsignedDecimalInt(int value) Write a UDATA header, then the value as an unsigned decimal integer.
void	writeUnsignedDecimalIntDTagElement(int tag, int value) Write an element start header using DTAG with the tag to the output buffer, then the value as an unsigned decimal integer, then an element close.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING_LIMIT_1_BYTE

public static final int ENCODING_LIMIT_1_BYTE

See Also:

Constant Field Values

ENCODING_LIMIT_2_BYTES

public static final int ENCODING_LIMIT_2_BYTES

See Also:

Constant Field Values

ENCODING_LIMIT_3_BYTES

public static final int ENCODING_LIMIT_3_BYTES

See Also:

Constant Field Values

Constructor Detail

BinaryXmlEncoder

public BinaryXmlEncoder(int initialCapacity)

Create a new BinaryXmlEncoder to use a DynamicByteBuffer with the initialCapacity. When done, you should call getOutput().

Parameters:

initialCapacity - The initial capacity of buffer().

BinaryXmlEncoder

public BinaryXmlEncoder()

Create a new BinaryXmlEncoder with a default DynamicByteBuffer for the output buffer. When done, you shoul call getOutput().

Method Detail

getOffset

public final int getOffset()

Get the current offset where the next data will be written in the output buffer.

Returns:

The offset in the output buffer.

getOutput

public final ByteBuffer getOutput()

Return a slice of the output buffer up to the current position.

Returns:

A ByteBuffer which shares the same underlying buffer with the output buffer.

writeElementStartDTag

public final void writeElementStartDTag(int tag)

Write an element start header using DTAG with the tag to the output buffer.

Parameters:

tag - The DTAG tag.

writeElementClose

public final void writeElementClose()

Write an element close to the output buffer.

writeBlob

public final void writeBlob(Blob value)

Write a BLOB header, then the bytes of the blob value to the output buffer.

Parameters:

value - A Blob with the buffer for the value.

writeBlobDTagElement

public final void writeBlobDTagElement(int tag,
                        Blob value)

Write an element start header using DTAG with the tag to the output buffer, then the blob, then an element close. (If you want to just write the blob, use writeBlob.)

Parameters:

tag - The DTAG tag.

value - A Blob with the buffer for the value.

writeOptionalBlobDTagElement

public final void writeOptionalBlobDTagElement(int tag,
                                Blob value)

If value.buf() is null or value.size() is 0 then do nothing, otherwise call writeBlobDTagElement.

Parameters:

tag - The DTAG tag.

value - A Blob with the buffer for the value.

writeUData

public final void writeUData(Blob value)

Write a UDATA header, then the bytes of the UDATA value to the output buffer.

Parameters:

value - A Blob with the buffer for the value.

writeUDataDTagElement

public final void writeUDataDTagElement(int tag,
                         Blob value)

Write an element start header using DTAG with the tag to the output buffer, then the UDATA value, then an element close. (If you want to just write the UDATA value, use writeUData.)

Parameters:

tag - The DTAG tag.

value - A Blob with the buffer for the value.

writeOptionalUDataDTagElement

public final void writeOptionalUDataDTagElement(int tag,
                                 Blob value)

If value.buf() is null or value.size() is 0 then do nothing, otherwise call writeUDataDTagElement.

Parameters:

tag - The DTAG tag.

value - A Blob with the buffer for the value.

writeUnsignedDecimalInt

public final void writeUnsignedDecimalInt(int value)

Write a UDATA header, then the value as an unsigned decimal integer.

Parameters:

value - The unsigned integer.

writeUnsignedDecimalIntDTagElement

public final void writeUnsignedDecimalIntDTagElement(int tag,
                                      int value)

Write an element start header using DTAG with the tag to the output buffer, then the value as an unsigned decimal integer, then an element close. (If you want to just write the integer, use writeUnsignedDecimalInt.)

Parameters:

tag - The DTAG tag.

value - The unsigned integer.

writeOptionalUnsignedDecimalIntDTagElement

public final void writeOptionalUnsignedDecimalIntDTagElement(int tag,
                                              int value)

If value is negative then do nothing, otherwise call writeUnsignedDecimalIntDTagElement.

Parameters:

tag - The DTAG tag.

value - The unsigned integer.

writeAbsDoubleBigEndianBlob

public final void writeAbsDoubleBigEndianBlob(double value)

writeTimeMillisecondsDTagElement

public final void writeTimeMillisecondsDTagElement(int tag,
                                    double milliseconds)

Write an element start header using DTAG with the tag to the output buffer, then the absolute value of milliseconds as a big endian BLOB converted to 4096 ticks per second, then an element close. (If you want to just write the integer, use writeUnsignedDecimalInt.)

Parameters:

tag - The DTAG tag.

milliseconds - The the number of milliseconds.

writeOptionalTimeMillisecondsDTagElement

public final void writeOptionalTimeMillisecondsDTagElement(int tag,
                                            double milliseconds)

If milliseconds is negative then do nothing, otherwise call writeTimeMillisecondsDTagElement.

Parameters:

tag - The DTAG tag.

milliseconds - The the number of milliseconds.