com.google.gerrit.index

Class Schema<T>

java.lang.Object

com.google.gerrit.index.Schema<T>

public class Schema<T>
extends java.lang.Object

Specific version of a secondary index schema.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Builder<T>
static class	Schema.Values<T>

Constructor Summary

Constructors

Constructor and Description
Schema(int version, java.lang.Iterable<FieldDef<T,?>> fields)
Schema(java.lang.Iterable<FieldDef<T,?>> fields)

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<Schema.Values<T>>	buildFields(T obj) Build all fields in the schema from an input object.
java.util.Optional<FieldDef<T,?>>	getField(FieldDef<T,?> first, FieldDef<T,?>... rest) Look up fields in this schema.
com.google.common.collect.ImmutableMap<java.lang.String,FieldDef<T,?>>	getFields() Get all fields in this schema.
com.google.common.collect.ImmutableMap<java.lang.String,FieldDef<T,?>>	getStoredFields()
int	getVersion()
boolean	hasField(FieldDef<T,?> field) Check whether a field is present in this schema.
void	setVersion(int version)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Schema

public Schema(java.lang.Iterable<FieldDef<T,?>> fields)

Schema

public Schema(int version,
              java.lang.Iterable<FieldDef<T,?>> fields)

Method Detail

getVersion

public final int getVersion()

getFields

public final com.google.common.collect.ImmutableMap<java.lang.String,FieldDef<T,?>> getFields()

Get all fields in this schema.

This is primarily useful for iteration. Most callers should prefer one of the helper methods getField(FieldDef, FieldDef...) or hasField(FieldDef) to looking up fields by name

Returns:

all fields in this schema indexed by name.

getStoredFields

public final com.google.common.collect.ImmutableMap<java.lang.String,FieldDef<T,?>> getStoredFields()

Returns:

all fields in this schema where FieldDef.isStored() is true.

getField

@SafeVarargs
public final java.util.Optional<FieldDef<T,?>> getField(FieldDef<T,?> first,
                                                                     FieldDef<T,?>... rest)

Look up fields in this schema.

Parameters:

first - the preferred field to look up.

rest - additional fields to look up.

Returns:

the first field in the schema matching first or rest, in order, or absent if no field matches.

hasField

public final boolean hasField(FieldDef<T,?> field)

Check whether a field is present in this schema.

Parameters:

field - field to look up.

Returns:

whether the field is present.

buildFields

public final java.lang.Iterable<Schema.Values<T>> buildFields(T obj)

Build all fields in the schema from an input object.

Null values are omitted, as are fields which cause errors, which are logged.

Parameters:

obj - input object.

Returns:

all non-null field values from the object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setVersion

public void setVersion(int version)