FieldDef (Gerrit Review Plugin API Documentation)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.google.gerrit.server.index.FieldDef<I,T>

Type Parameters:
I - input type from which documents are created and search results are returned.
T - type that should be extracted from the input object when converting to an index document.

Direct Known Subclasses:

FieldDef.Repeatable, FieldDef.Single
```
public abstract class FieldDef<I,T>
extends Object
```
Definition of a field stored in the secondary index.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FieldDef.FillArgs` Arguments needed to fill in missing data in the input object.
`static class`	`FieldDef.Repeatable<I,T>` Definition of a repeatable field.
`static class`	`FieldDef.Single<I,T>` Definition of a single (non-repeatable) field.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract T`	`get(I input, FieldDef.FillArgs args)` Get the field contents from the input object.
`String`	`getName()`
`FieldType<?>`	`getType()`
`abstract boolean`	`isRepeatable()`
`boolean`	`isStored()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public final String getName()
```
    Returns:
    name of the field.
  - getType
```
public final FieldType<?> getType()
```
    Returns:
    type of the field; for repeatable fields, the inner type, not the iterable type.
  - isStored
```
public final boolean isStored()
```
    Returns:
    whether the field should be stored in the index.
  - get
```
public abstract T get(I input,
    FieldDef.FillArgs args)
               throws com.google.gwtorm.server.OrmException
```
    Get the field contents from the input object.
    
    Parameters:
    input - input object.
    args - arbitrary arguments needed to fill in indexable fields of the input object.
    
    Returns:
    the field value(s) to index.
    
    Throws:
    
    com.google.gwtorm.server.OrmException
  - isRepeatable
```
public abstract boolean isRepeatable()
```
    Returns:
    whether the field is repeatable.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method