Package fr.gouv.vitam.common.metrics

Enum VitamMetricsType

java.lang.Object

java.lang.Enum<VitamMetricsType>

fr.gouv.vitam.common.metrics.VitamMetricsType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VitamMetricsType>

public enum VitamMetricsType
extends java.lang.Enum<VitamMetricsType>

Enums to use for the configuration of VitamMetrics through the VitamMetricsConfiguration class.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUSINESS
JVM
REST

Method Summary

Modifier and Type	Method	Description
static VitamMetricsType	get(java.lang.String metricTypeName)	Retrieve an VitamMetricsType given a name.
java.lang.String	getElasticsearchIndex()	Return the elasticsearch index of this metric type
java.lang.String	getName()	Return the name of the enum as a String
static VitamMetricsType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static VitamMetricsType[]	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

REST

public static final VitamMetricsType REST

JVM

public static final VitamMetricsType JVM

BUSINESS

public static final VitamMetricsType BUSINESS

Method Detail

values

public static VitamMetricsType[] 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 (VitamMetricsType c : VitamMetricsType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VitamMetricsType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Return the name of the enum as a String

Returns:

String

getElasticsearchIndex

public java.lang.String getElasticsearchIndex()

Return the elasticsearch index of this metric type

Returns:

String

get

public static VitamMetricsType get(java.lang.String metricTypeName)
                            throws java.lang.IllegalArgumentException

Retrieve an VitamMetricsType given a name. Throws an IllegalArgumentException if the name doesn't exists.

Parameters:

metricTypeName -

Returns:

VitamMetricsType

Throws:

java.lang.IllegalArgumentException