Package com.apple.foundationdb.tuple

Class TupleOrdering

java.lang.Object

com.apple.foundationdb.tuple.TupleOrdering

@API(UNSTABLE)
public class TupleOrdering
extends Object

Helper methods for encoding Tuples in ways that implement SQL-like ordering.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TupleOrdering.Direction	Direction of ordering.

Method Summary

Modifier and Type	Method	Description
static byte[]	pack(Tuple tuple, TupleOrdering.Direction direction)	Encode the given tuple in a way that unordered byte comparison respects the given direction.
static Tuple	unpack(byte[] packed, TupleOrdering.Direction direction)	Decode the result of pack(com.apple.foundationdb.tuple.Tuple, com.apple.foundationdb.tuple.TupleOrdering.Direction), recovering the original tuple.

Methods inherited from class java.lang.Object

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

Method Details

pack

@Nonnull
public static byte[] pack(@Nonnull
 Tuple tuple,
 @Nonnull
 TupleOrdering.Direction direction)

Encode the given tuple in a way that unordered byte comparison respects the given direction.

Parameters:

tuple - tuple to encode

direction - direction of desired ordering

Returns:

a byte string that compares properly

unpack

@Nonnull
public static Tuple unpack(@Nonnull
 byte[] packed,
 @Nonnull
 TupleOrdering.Direction direction)

Decode the result of pack(com.apple.foundationdb.tuple.Tuple, com.apple.foundationdb.tuple.TupleOrdering.Direction), recovering the original tuple.

Parameters:

packed - comparable byte string encoding

direction - direction used by encoding

Returns:

tuple that would encode that way