brown.tracingplane.baggageprotocol

Class BagKey

java.lang.Object

brown.tracingplane.baggageprotocol.BagKey

All Implemented Interfaces:

java.lang.Comparable<BagKey>

Direct Known Subclasses:

BagKey.Indexed, BagKey.Keyed

public abstract class BagKey
extends java.lang.Object
implements java.lang.Comparable<BagKey>

A BagKey is used to look up data items and child bags within a baggage instance.

BagKey instances should be created with the static methods indexed and keyed. As per the Baggage protocol, fields can either be keyed (using arbitrary bytes) or indexed (with an unsigned integer). Indexes for fields are statically assigned for efficiency in more established protocols. It is recommended to use named keys for ad-hoc data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BagKey.Indexed An Indexed BagKey is one that uses an integer as identifier (versus arbitrary bytes for a BagKey.Keyed key)
static class	BagKey.Keyed A Keyed BagKey is one that uses arbitrary bytes as identifier (versus an integer for BagKey.Indexed key)

Field Summary

Fields

Modifier and Type	Field and Description
BagOptions	options

Method Summary

Modifier and Type	Method and Description
abstract java.nio.ByteBuffer	atomPayload()
abstract AtomPrefixes.AtomPrefix	atomPrefix(int level, BagOptions options)
static BagKey	indexed(int index)
static BagKey	indexed(int index, BagOptions options)
static BagKey	keyed(java.nio.ByteBuffer key)
static BagKey	keyed(java.nio.ByteBuffer key, BagOptions options)
static BagKey	keyed(java.lang.String name, BagOptions options)
static BagKey	named(java.lang.String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

options

public final BagOptions options

Method Detail

atomPrefix

public abstract AtomPrefixes.AtomPrefix atomPrefix(int level,
                                                   BagOptions options)

atomPayload

public abstract java.nio.ByteBuffer atomPayload()

indexed

public static BagKey indexed(int index)

indexed

public static BagKey indexed(int index,
                             BagOptions options)

named

public static BagKey named(java.lang.String name)

keyed

public static BagKey keyed(java.lang.String name,
                           BagOptions options)

keyed

public static BagKey keyed(java.nio.ByteBuffer key)

keyed

public static BagKey keyed(java.nio.ByteBuffer key,
                           BagOptions options)