Package com.apple.foundationdb.record.lucene.idformat

Class RecordIdFormat

java.lang.Object

com.apple.foundationdb.record.lucene.idformat.RecordIdFormat

public class RecordIdFormat
extends Object

The format model for the index key formatter. This class represents the structure (provided externally) describing the structure of the ID Key. The key is a Tuple, consisting of tuple elements, which can be nested by containing additional tuples. The structure of the format is similar, consisting of a top-level RecordIdFormat.TupleElement with RecordIdFormat.TupleElement.children that can be either leaves (RecordIdFormat.FormatElementType) or nested RecordIdFormat.TupleElement. The marker interface RecordIdFormat.FormatElement is a super-interface for RecordIdFormat.TupleElement and RecordIdFormat.FormatElementType.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecordIdFormat.FormatElement	Marker interface for both RecordIdFormat.TupleElement and RecordIdFormat.FormatElementType.
static enum	RecordIdFormat.FormatElementType	The enum of the various types available for the format.
static class	RecordIdFormat.TupleElement	A collection of elements matching a Tuple structure in the key.

Constructor Summary

Constructors

Constructor	Description
RecordIdFormat(RecordIdFormat.TupleElement element)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RecordIdFormat.TupleElement	getElement()
int	hashCode()
static RecordIdFormat	of(RecordIdFormat.FormatElement... elements)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RecordIdFormat

public RecordIdFormat(@Nonnull
 RecordIdFormat.TupleElement element)

Method Details

of

public static RecordIdFormat of(RecordIdFormat.FormatElement... elements)

getElement

@Nonnull
public RecordIdFormat.TupleElement getElement()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object