com.google.gerrit.metrics

Class Field<T>

java.lang.Object

com.google.gerrit.metrics.Field<T>

Type Parameters:

T - type of field

public class Field<T>
extends Object

Describes a bucketing field used by a metric.

Method Summary

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

Break down metrics by boolean true/false.

Parameters:

name - field name

Returns:

boolean field

ofBoolean

public static Field<Boolean> ofBoolean(String name,
                                       String description)

Break down metrics by boolean true/false.

Parameters:

name - field name

description - field description

Returns:

boolean field

ofEnum

public static <E extends Enum<E>> Field<E> ofEnum(Class<E> enumType,
                                                  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 Enum<E>> Field<E> ofEnum(Class<E> enumType,
                                                  String name,
                                                  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<String> ofString(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<String> ofString(String name,
                                     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<Integer> ofInteger(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<Integer> ofInteger(String name,
                                       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 String getName()

Returns:

name of this field within the metric.

getType

public Class<T> getType()

Returns:

type of value used within the field.

getDescription

public String getDescription()

Returns:

description text for the field explaining its range of values.

formatter

public com.google.common.base.Function<T,String> formatter()