brown.tracingplane.impl

Class NestedBaggageContextProvider

java.lang.Object

brown.tracingplane.impl.NestedBaggageContextProvider

All Implemented Interfaces:

BaggageProvider<NestedBaggageContext>

public class NestedBaggageContextProvider
extends java.lang.Object
implements BaggageProvider<NestedBaggageContext>

BaggageProvider for NestedBaggageContext, which extends AtomContext to interpret atoms as nested data structures.

Constructor Summary

Constructors

Constructor and Description
NestedBaggageContextProvider()

Method Summary

Modifier and Type	Method and Description
NestedBaggageContext	branch(NestedBaggageContext from) Create and return a copy of from.
NestedBaggageContext	deserialize(byte[] serialized, int offset, int length) Deserialize the provided serialized baggage representation.
NestedBaggageContext	deserialize(java.nio.ByteBuffer buf) Deserialize the provided serialized baggage representation.
void	discard(NestedBaggageContext baggage) Discards baggage.
boolean	isValid(BaggageContext baggage)
NestedBaggageContext	join(NestedBaggageContext left, NestedBaggageContext right) Merge the contents of left and right and return as baggage.
NestedBaggageContext	newInstance()
byte[]	serialize(NestedBaggageContext baggage) Serialize the provided baggage instance to its byte representation.
byte[]	serialize(NestedBaggageContext baggage, int maximumSerializedSize) Serialize the provided baggage instance to its byte representation and trim the baggage so that its serialized size is <= maximumSerializedSize.

Methods inherited from class java.lang.Object

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

Constructor Detail

NestedBaggageContextProvider

public NestedBaggageContextProvider()

Method Detail

isValid

public boolean isValid(BaggageContext baggage)

Specified by:

isValid in interface BaggageProvider<NestedBaggageContext>

Parameters:

baggage - a BaggageContext to test

Returns:

true if baggage is an instance of B or if baggage is null.

newInstance

public NestedBaggageContext newInstance()

Specified by:

newInstance in interface BaggageProvider<NestedBaggageContext>

Returns:

a new instance of B, which may be null to indicate an empty baggage

discard

public void discard(NestedBaggageContext baggage)

Description copied from interface: BaggageProvider

Discards baggage. If this TransitLayer performs anything like reference counting, then this method is where decrementing reference counts would happen.

Specified by:

discard in interface BaggageProvider<NestedBaggageContext>

Parameters:

baggage - a baggage instance

branch

public NestedBaggageContext branch(NestedBaggageContext from)

Description copied from interface: BaggageProvider

Create and return a copy of from. If this TransitLayer performs anything like reference counting, then this method might just return from while incrementing reference counts. This method might create a new instance of B and might even modify the contents of from

Specified by:

branch in interface BaggageProvider<NestedBaggageContext>

Parameters:

from - a baggage instance, possibly null

Returns:

a baggage instance branched from from, possibly null

join

public NestedBaggageContext join(NestedBaggageContext left,
                                 NestedBaggageContext right)

Description copied from interface: BaggageProvider

Merge the contents of left and right and return as baggage. left and right should be treated as discarded (or reused) after this method call.

Specified by:

join in interface BaggageProvider<NestedBaggageContext>

Parameters:

left - a baggage instance, possibly null

right - a baggage instance, possibly null

Returns:

a baggage instance with merged contents from left and right

deserialize

public NestedBaggageContext deserialize(byte[] serialized,
                                        int offset,
                                        int length)

Description copied from interface: BaggageProvider

Deserialize the provided serialized baggage representation.

Specified by:

deserialize in interface BaggageProvider<NestedBaggageContext>

Parameters:

serialized - a serialized baggage

offset - offset into the array where the baggage bytes begin

length - lenft of the baggage bytes

Returns:

a deserialized baggage instance, possibly null

deserialize

public NestedBaggageContext deserialize(java.nio.ByteBuffer buf)

Description copied from interface: BaggageProvider

Deserialize the provided serialized baggage representation.

Specified by:

deserialize in interface BaggageProvider<NestedBaggageContext>

Parameters:

buf - a serialized baggage

Returns:

a deserialized baggage instance, possibly null

serialize

public byte[] serialize(NestedBaggageContext baggage)

Description copied from interface: BaggageProvider

Serialize the provided baggage instance to its byte representation. This method should behave as though #branch(Baggage) is also being called prior to serialization.

Specified by:

serialize in interface BaggageProvider<NestedBaggageContext>

Parameters:

baggage - a baggage instance to serialize, possibly null

Returns:

the serialized representation of baggage, which might be null or an empty byte array

serialize

public byte[] serialize(NestedBaggageContext baggage,
                        int maximumSerializedSize)

Description copied from interface: BaggageProvider

Serialize the provided baggage instance to its byte representation and trim the baggage so that its serialized size is <= maximumSerializedSize. This method should behave as though #branch(Baggage) is also being called prior to serialization.

Specified by:

serialize in interface BaggageProvider<NestedBaggageContext>

Parameters:

baggage - a baggage instance to serialize, possibly null

maximumSerializedSize - the maximum size in bytes of the serialized baggage.

Returns:

the serialized representation of baggage, which might be null or an empty byte array