Description.FieldOrdering (Gerrit Review Plugin API Documentation)

java.lang.Object
- java.lang.Enum<Description.FieldOrdering>
- - com.google.gerrit.metrics.Description.FieldOrdering

All Implemented Interfaces:

Serializable, Comparable<Description.FieldOrdering>

Enclosing class:

Description
```
public static enum Description.FieldOrdering
extends Enum<Description.FieldOrdering>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AT_END` Default ordering places fields at end of the parent metric name.
`PREFIX_FIELDS_BASENAME` Splits the metric name by inserting field values before the last '/' in the metric name.

Method Summary

Methods
Modifier and Type	Method and Description
`static Description.FieldOrdering`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Description.FieldOrdering[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AT_END
```
public static final Description.FieldOrdering AT_END
```
    Default ordering places fields at end of the parent metric name.
  - PREFIX_FIELDS_BASENAME
```
public static final Description.FieldOrdering PREFIX_FIELDS_BASENAME
```
    Splits the metric name by inserting field values before the last '/' in the metric name. For example "plugins/replication/push_latency" with a Field.ofString("remote") will create submetrics named "plugins/replication/some-server/push_latency".
- Method Detail
  - values
```
public static Description.FieldOrdering[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Description.FieldOrdering c : Description.FieldOrdering.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Description.FieldOrdering valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum Description.FieldOrdering

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AT_END

PREFIX_FIELDS_BASENAME

Method Detail

values

valueOf