brown.tracingplane.baggageprotocol

Class BaggageWriter

java.lang.Object

brown.tracingplane.baggageprotocol.BaggageWriter

All Implemented Interfaces:

ElementWriter

public class BaggageWriter
extends java.lang.Object
implements ElementWriter

Used for writing out baggage atoms that adhere to the baggage protocol TODO: comments and documentation

Method Summary

Modifier and Type	Method and Description
java.util.List<java.nio.ByteBuffer>	atoms() Get the atoms that were written to this BaggageWriter
static BaggageWriter	create()
static BaggageWriter	createAndMergeWith(java.lang.Iterable<java.nio.ByteBuffer> atoms)
static BaggageWriter	createAndMergeWith(java.lang.Iterable<java.nio.ByteBuffer> a0, java.lang.Iterable<java.nio.ByteBuffer> a1)
static BaggageWriter	createAndMergeWith(java.util.Iterator<java.nio.ByteBuffer> atoms)
static BaggageWriter	createAndMergeWith(java.util.Iterator<java.nio.ByteBuffer> a0, java.util.Iterator<java.nio.ByteBuffer> a1)
BaggageWriter	didOverflowHere(boolean didOverflow)
BaggageWriter	didTrimHere(boolean didTrim)
BaggageWriter	enter(BagKey field)
BaggageWriter	exit()
void	finish() Indicate that writing to this writer has finished, and if the writer was also merging with other atoms, they should be finished
void	flush() Ensure that any buffers created with newDataAtom are finished.
java.nio.ByteBuffer	newDataAtom(int expectedSize) Creates a byte buffer with expectedSize bytes of free space.
void	sortData() Sort any data written between the start of the current bag and now
BaggageWriter	writeBytes(java.nio.ByteBuffer buf) Write a data atom with the provided buf content

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BaggageWriter create()

createAndMergeWith

public static BaggageWriter createAndMergeWith(java.lang.Iterable<java.nio.ByteBuffer> atoms)

createAndMergeWith

public static BaggageWriter createAndMergeWith(java.util.Iterator<java.nio.ByteBuffer> atoms)

createAndMergeWith

public static BaggageWriter createAndMergeWith(java.lang.Iterable<java.nio.ByteBuffer> a0,
                                               java.lang.Iterable<java.nio.ByteBuffer> a1)

createAndMergeWith

public static BaggageWriter createAndMergeWith(java.util.Iterator<java.nio.ByteBuffer> a0,
                                               java.util.Iterator<java.nio.ByteBuffer> a1)

enter

public BaggageWriter enter(BagKey field)

exit

public BaggageWriter exit()

didOverflowHere

public BaggageWriter didOverflowHere(boolean didOverflow)

didTrimHere

public BaggageWriter didTrimHere(boolean didTrim)

newDataAtom

public java.nio.ByteBuffer newDataAtom(int expectedSize)

Creates a byte buffer with expectedSize bytes of free space. The atom can be written to as normal. Not all of the free space must be filled

Specified by:

newDataAtom in interface ElementWriter

Parameters:

expectedSize - the amount of space needed

Returns:

a ByteBuffer with at least expectedSize bytes remaining

writeBytes

public BaggageWriter writeBytes(java.nio.ByteBuffer buf)

Write a data atom with the provided buf content

Specified by:

writeBytes in interface ElementWriter

Parameters:

buf - the payload of the data atom to write

Returns:

this BaggageWriter instance

sortData

public void sortData()

Sort any data written between the start of the current bag and now

Specified by:

sortData in interface ElementWriter

flush

public void flush()

Ensure that any buffers created with newDataAtom are finished.

Specified by:

flush in interface ElementWriter

finish

public void finish()

Indicate that writing to this writer has finished, and if the writer was also merging with other atoms, they should be finished

atoms

public java.util.List<java.nio.ByteBuffer> atoms()

Get the atoms that were written to this BaggageWriter

This method should not be called while writing is in progress

Returns:

the atoms that were written to this BaggageWriter.