org.jmisb.api.klv

Class ArrayBuilder

java.lang.Object

org.jmisb.api.klv.ArrayBuilder

public class ArrayBuilder
extends Object

Builder for linear byte arrays.

This class provides a Builder pattern to allow generating a byte array from other byte arrays, or from some common KLV types.

It supports method chaining to make the code more fluent.

Constructor Summary

Constructors

Constructor and Description
ArrayBuilder() Constructor.

Method Summary

Modifier and Type	Method and Description
ArrayBuilder	append(byte[] bytes) Append a byte array.
ArrayBuilder	append(UniversalLabel universalLabel) Append a Universal Label.
ArrayBuilder	appendAsBerLength(int length) Append an unsigned integer length encoded as a BER value.
ArrayBuilder	appendAsBit(boolean b) Append a Boolean value as a single bit.
ArrayBuilder	appendAsFloat32Primitive(float value) Append a 32-bit floating point (float) value.
ArrayBuilder	appendAsFloat64Primitive(double value) Append a 64-bit floating point (double) value.
ArrayBuilder	appendAsInt32Primitive(int value) Append a 32-bit signed integer (int) value.
ArrayBuilder	appendAsOID(int value) Append an unsigned integer encoded as a BER-OID value.
ArrayBuilder	appendAsUInt32Primitive(long value) Append a 32-bit unsigned integer (long with range of uint32) value.
ArrayBuilder	appendByte(byte b) Append a single byte.
ArrayBuilder	flushBitBuffer() Flush any stored bits to the array.
ArrayBuilder	prepend(UniversalLabel universalLabel) Prepend a Universal Label to the start of the array.
ArrayBuilder	prependLength() Prepend a BER encoded length of the following bytes to the byte array.
ArrayBuilder	prependLengthPlus(int additionalLength) Prepend a BER encoded length of the following bytes to the byte array.
byte[]	toBytes() Build the byte array from the appended parts.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayBuilder

public ArrayBuilder()

Constructor.

Method Detail

append

public ArrayBuilder append(byte[] bytes)

Append a byte array.

Parameters:

bytes - the byte array to append.

Returns:

this instance, to support method chaining.

appendByte

public ArrayBuilder appendByte(byte b)

Append a single byte.

Parameters:

b - the byte to append.

Returns:

this instance, to support method chaining.

appendAsBit

public ArrayBuilder appendAsBit(boolean b)

Append a Boolean value as a single bit.

Parameters:

b - the boolean value to append.

Returns:

this instance, to support method chaining.

flushBitBuffer

public ArrayBuilder flushBitBuffer()

Flush any stored bits to the array.

If there are not enough bits to fill a byte, the last byte will be zero-bit filled.

Returns:

this instance, to support method chaining.

appendAsOID

public ArrayBuilder appendAsOID(int value)

Append an unsigned integer encoded as a BER-OID value.

Parameters:

value - the unsigned integer value.

Returns:

this instance, to support method chaining.

appendAsBerLength

public ArrayBuilder appendAsBerLength(int length)

Append an unsigned integer length encoded as a BER value.

This is usually what you want for a length field.

If the encoding says "BER-OID", use appendAsOID(int) instead.

Parameters:

length - the unsigned integer value.

Returns:

this instance, to support method chaining.

appendAsFloat64Primitive

public ArrayBuilder appendAsFloat64Primitive(double value)

Append a 64-bit floating point (double) value.

Parameters:

value - the value to append

Returns:

this instance, to support method chaining.

appendAsFloat32Primitive

public ArrayBuilder appendAsFloat32Primitive(float value)

Append a 32-bit floating point (float) value.

Parameters:

value - the value to append

Returns:

this instance, to support method chaining.

appendAsInt32Primitive

public ArrayBuilder appendAsInt32Primitive(int value)

Append a 32-bit signed integer (int) value.

Parameters:

value - the value to append

Returns:

this instance, to support method chaining.

appendAsUInt32Primitive

public ArrayBuilder appendAsUInt32Primitive(long value)

Append a 32-bit unsigned integer (long with range of uint32) value.

Parameters:

value - the value to append

Returns:

this instance, to support method chaining.

append

public ArrayBuilder append(UniversalLabel universalLabel)

Append a Universal Label.

Parameters:

universalLabel - the value to append

Returns:

this instance, to support method chaining.

prepend

public ArrayBuilder prepend(UniversalLabel universalLabel)

Prepend a Universal Label to the start of the array.

Parameters:

universalLabel - the value to prepend

Returns:

this instance, to support method chaining.

prependLength

public ArrayBuilder prependLength()

Prepend a BER encoded length of the following bytes to the byte array.

This is the type of representation used for Variable Length Packs. Be careful about subsequent operations that append to the array, because this length field will not be updated.

Returns:

this instance, to support method chaining.

prependLengthPlus

public ArrayBuilder prependLengthPlus(int additionalLength)

Prepend a BER encoded length of the following bytes to the byte array.

This is like prependLength, but allows an additional (known) number of bytes to be include in the length, which is useful for adding checksum-type information.

Be careful about subsequent operations that append to the array, because this length field will not be updated.

Parameters:

additionalLength - additional length to add to the calculated length.

Returns:

this instance, to support method chaining.

toBytes

public byte[] toBytes()

Build the byte array from the appended parts.

Returns:

the byte array.