brown.tracingplane.baggageprotocol

Class HeaderSerialization

java.lang.Object

brown.tracingplane.baggageprotocol.HeaderSerialization

public class HeaderSerialization
extends java.lang.Object

Contains methods to serialize and deserialize header atoms (eg, AtomPrefixes.IndexedHeaderPrefix and AtomPrefixes.KeyedHeaderPrefix atoms)

Field Summary

Fields

Modifier and Type	Field and Description
static int	PREFIX_SIZE Atom prefixes are 1 byte long

Method Summary

Modifier and Type	Method and Description
static BagKey	parse(AtomPrefixes.HeaderPrefix prefix, java.nio.ByteBuffer buf) Parses a bag key
static BagKey	parse(java.nio.ByteBuffer atom) Parses a bag key from the provided atom
static BagKey	parseIndexedHeaderPayload(AtomPrefixes.HeaderPrefix prefix, java.nio.ByteBuffer buf) Parse the payload of an indexed header
static BagKey	parseKeyedHeaderPayload(AtomPrefixes.HeaderPrefix prefix, java.nio.ByteBuffer buf) Parse the payload of a keyed header
static java.nio.ByteBuffer	serialize(BagKey.Indexed bagKey, int level) Serialize the header atom, including prefix byte, for the provided bagKey and level
static java.nio.ByteBuffer	serialize(BagKey.Keyed bagKey, int level) Serialize the header atom, including prefix byte, for the provided bagKey and level
static java.nio.ByteBuffer	serialize(BagKey bagKey, int level) Serialize the header atom, including prefix byte, for the provided bagKey and level
static int	serializedSize(BagKey.Indexed bagKey) Calculates the serialized size of an Indexed header atom including its prefix
static int	serializedSize(BagKey.Keyed bagKey) Calculates the serialized size of a Keyed header atom including its prefix
static java.nio.ByteBuffer	serializePayload(BagKey.Indexed bagKey) Serialize the atom payload for the provided bagkey, excluding atom prefix.
static java.nio.ByteBuffer	serializePayload(BagKey.Keyed bagKey) Serialize the atom payload for the provided bagkey, excluding atom prefix.
static void	writeAtom(java.nio.ByteBuffer buf, BagKey.Indexed bagKey, int level) Write an atom to the provided buffer for the specified bagKey and level.
static void	writeAtom(java.nio.ByteBuffer buf, BagKey.Keyed bagKey, int level) Write an atom to the provided buffer for the specified bagKey and level.
static void	writeAtomPayload(java.nio.ByteBuffer buf, BagKey.Indexed bagKey) Write the payload of an Indexed header atom to the provided buf
static void	writeAtomPayload(java.nio.ByteBuffer buf, BagKey.Keyed bagKey) Write the payload of an Keyed header atom to the provided buf
static void	writeAtomPrefix(java.nio.ByteBuffer buf, BagKey.Indexed bagKey, int level) Write the prefix byte of an Indexed header atom to the provided buf
static void	writeAtomPrefix(java.nio.ByteBuffer buf, BagKey.Keyed bagKey, int level) Write the prefix byte of a Keyed header atom to the provided buf

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_SIZE

public static final int PREFIX_SIZE

Atom prefixes are 1 byte long

See Also:

Constant Field Values

Method Detail

serializedSize

public static int serializedSize(BagKey.Indexed bagKey)

Calculates the serialized size of an Indexed header atom including its prefix

Parameters:

bagKey - an Indexed bagkey

Returns:

the serialized size of the atom for this bagkey

serializedSize

public static int serializedSize(BagKey.Keyed bagKey)

Calculates the serialized size of a Keyed header atom including its prefix

Parameters:

bagKey - a Keyed header bagKey

Returns:

the serialized size of the atom for this bagKey

writeAtom

public static void writeAtom(java.nio.ByteBuffer buf,
                             BagKey.Indexed bagKey,
                             int level)

Write an atom to the provided buffer for the specified bagKey and level. This will write both the atom prefix and its payload

Parameters:

buf - the buffer to write to

bagKey - the bagKey to write

level - the level of the bagKey

writeAtom

public static void writeAtom(java.nio.ByteBuffer buf,
                             BagKey.Keyed bagKey,
                             int level)

Write an atom to the provided buffer for the specified bagKey and level. This will write both the atom prefix and its payload

Parameters:

buf - the buffer to write to

bagKey - the bagKey to write

level - the level of the bagKey

writeAtomPrefix

public static void writeAtomPrefix(java.nio.ByteBuffer buf,
                                   BagKey.Indexed bagKey,
                                   int level)

Write the prefix byte of an Indexed header atom to the provided buf

Parameters:

buf - the buffer to write to

bagKey - the key of this header

level - the header level

writeAtomPrefix

public static void writeAtomPrefix(java.nio.ByteBuffer buf,
                                   BagKey.Keyed bagKey,
                                   int level)

Write the prefix byte of a Keyed header atom to the provided buf

Parameters:

buf - the buffer to write to

bagKey - the key of this header

level - the header level

writeAtomPayload

public static void writeAtomPayload(java.nio.ByteBuffer buf,
                                    BagKey.Indexed bagKey)

Write the payload of an Indexed header atom to the provided buf

Parameters:

buf - the buffer to write to

bagKey - the key of this header

bagKey - the bagKey to write

writeAtomPayload

public static void writeAtomPayload(java.nio.ByteBuffer buf,
                                    BagKey.Keyed bagKey)

Write the payload of an Keyed header atom to the provided buf

Parameters:

buf - the buffer to write to

bagKey - the bagKey to write

serialize

public static java.nio.ByteBuffer serialize(BagKey bagKey,
                                            int level)

Serialize the header atom, including prefix byte, for the provided bagKey and level

Parameters:

bagKey - the key to write a header for

level - the level of this key

Returns:

the header atom representing the provided key and level

serialize

public static java.nio.ByteBuffer serialize(BagKey.Indexed bagKey,
                                            int level)

Serialize the header atom, including prefix byte, for the provided bagKey and level

Parameters:

bagKey - the key to write a header for

level - the level of this key

Returns:

the header atom representing the provided key and level

serialize

public static java.nio.ByteBuffer serialize(BagKey.Keyed bagKey,
                                            int level)

Serialize the header atom, including prefix byte, for the provided bagKey and level

Parameters:

bagKey - the key to write a header for

level - the level of this key

Returns:

the header atom representing the provided key and level

serializePayload

public static java.nio.ByteBuffer serializePayload(BagKey.Indexed bagKey)

Serialize the atom payload for the provided bagkey, excluding atom prefix. The returned buffer will have allocated room for a prefix byte, but not filled it. The position of the returned buffer will be the start of the payload.

Parameters:

bagKey - the key to write a header for

Returns:

a buffer containing the payload of the header atom

serializePayload

public static java.nio.ByteBuffer serializePayload(BagKey.Keyed bagKey)

Serialize the atom payload for the provided bagkey, excluding atom prefix. The returned buffer will have allocated room for a prefix byte, but not filled it. The position of the returned buffer will be the start of the payload.

Parameters:

bagKey - the key to write a header for

Returns:

a buffer containing the payload of the header atom

parse

public static BagKey parse(java.nio.ByteBuffer atom)
                    throws AtomLayerException,
                           BaggageLayerException

Parses a bag key from the provided atom

Parameters:

atom - a buffer containing both the prefix of the atom and its payload

Returns:

a bag key

Throws:

AtomLayerException - if the header payload could not be parsed

BaggageLayerException - if the atom is not a header atom

parse

public static BagKey parse(AtomPrefixes.HeaderPrefix prefix,
                           java.nio.ByteBuffer buf)
                    throws BaggageLayerException

Parses a bag key

Parameters:

prefix - the prefix of the atom

buf - the payload of the atom

Returns:

a bag key

Throws:

BaggageLayerException - if the atom is not a header atom or if the header payload could not be parsed

parseIndexedHeaderPayload

public static BagKey parseIndexedHeaderPayload(AtomPrefixes.HeaderPrefix prefix,
                                               java.nio.ByteBuffer buf)
                                        throws BaggageLayerException

Parse the payload of an indexed header

Parameters:

prefix - the prefix of this atom

buf - the payload of the atom

Returns:

the parsed bagkey

Throws:

BaggageLayerException - if the atom payload could not be parsed

parseKeyedHeaderPayload

public static BagKey parseKeyedHeaderPayload(AtomPrefixes.HeaderPrefix prefix,
                                             java.nio.ByteBuffer buf)
                                      throws BaggageLayerException

Parse the payload of a keyed header

Parameters:

prefix - the prefix of this atom

buf - the payload of the atom

Returns:

the parsed bagkey

Throws:

BaggageLayerException - if the atom payload could not be parsed