Field (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.metrics.Field<T>

Type Parameters:
T - type of field
```
public class Field<T>
extends java.lang.Object
```
Describes a bucketing field used by a metric.

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.common.base.Function<T,java.lang.String>`	`formatter()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getName()`
`java.lang.Class<T>`	`getType()`
`static Field<java.lang.Boolean>`	`ofBoolean(java.lang.String name)` Break down metrics by boolean true/false.
`static Field<java.lang.Boolean>`	`ofBoolean(java.lang.String name, java.lang.String description)` Break down metrics by boolean true/false.
`static <E extends java.lang.Enum<E>> Field<E>`	`ofEnum(java.lang.Class<E> enumType, java.lang.String name)` Break down metrics by cases of an enum.
`static <E extends java.lang.Enum<E>> Field<E>`	`ofEnum(java.lang.Class<E> enumType, java.lang.String name, java.lang.String description)` Break down metrics by cases of an enum.
`static Field<java.lang.Integer>`	`ofInteger(java.lang.String name)` Break down metrics by integer.
`static Field<java.lang.Integer>`	`ofInteger(java.lang.String name, java.lang.String description)` Break down metrics by integer.
`static Field<java.lang.String>`	`ofString(java.lang.String name)` Break down metrics by string.
`static Field<java.lang.String>`	`ofString(java.lang.String name, java.lang.String description)` Break down metrics by string.

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

- Method Detail
  - ofBoolean
```
public static Field<java.lang.Boolean> ofBoolean(java.lang.String name)
```
    Break down metrics by boolean true/false.
    
    Parameters:
    name - field name
    
    Returns:
    boolean field
  - ofBoolean
```
public static Field<java.lang.Boolean> ofBoolean(java.lang.String name,
                                 java.lang.String description)
```
    Break down metrics by boolean true/false.
    
    Parameters:
    name - field name
    description - field description
    
    Returns:
    boolean field
  - ofEnum
```
public static <E extends java.lang.Enum<E>> Field<E> ofEnum(java.lang.Class<E> enumType,
                                            java.lang.String name)
```
    Break down metrics by cases of an enum.
    
    Parameters:
    enumType - type of enum
    name - field name
    
    Returns:
    enum field
  - ofEnum
```
public static <E extends java.lang.Enum<E>> Field<E> ofEnum(java.lang.Class<E> enumType,
                                            java.lang.String name,
                                            java.lang.String description)
```
    Break down metrics by cases of an enum.
    
    Parameters:
    enumType - type of enum
    name - field name
    description - field description
    
    Returns:
    enum field
  - ofString
```
public static Field<java.lang.String> ofString(java.lang.String name)
```
    Break down metrics by string.
    Each unique string will allocate a new submetric. Do not use user content as a field value as field values are never reclaimed.
    
    Parameters:
    name - field name
    
    Returns:
    string field
  - ofString
```
public static Field<java.lang.String> ofString(java.lang.String name,
                               java.lang.String description)
```
    Break down metrics by string.
    Each unique string will allocate a new submetric. Do not use user content as a field value as field values are never reclaimed.
    
    Parameters:
    name - field name
    description - field description
    
    Returns:
    string field
  - ofInteger
```
public static Field<java.lang.Integer> ofInteger(java.lang.String name)
```
    Break down metrics by integer.
    Each unique integer will allocate a new submetric. Do not use user content as a field value as field values are never reclaimed.
    
    Parameters:
    name - field name
    
    Returns:
    integer field
  - ofInteger
```
public static Field<java.lang.Integer> ofInteger(java.lang.String name,
                                 java.lang.String description)
```
    Break down metrics by integer.
    Each unique integer will allocate a new submetric. Do not use user content as a field value as field values are never reclaimed.
    
    Parameters:
    name - field name
    description - field description
    
    Returns:
    integer field
  - getName
```
public java.lang.String getName()
```
    Returns:
    name of this field within the metric.
  - getType
```
public java.lang.Class<T> getType()
```
    Returns:
    type of value used within the field.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns:
    description text for the field explaining its range of values.
  - formatter
```
public com.google.common.base.Function<T,java.lang.String> formatter()
```

Class Field<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

ofBoolean

ofBoolean

ofEnum

ofEnum

ofString

ofString

ofInteger

ofInteger

getName

getType

getDescription

formatter