io.opencensus.stats

Enum StatsCollectionState

java.lang.Object

java.lang.Enum<StatsCollectionState>

io.opencensus.stats.StatsCollectionState

All Implemented Interfaces:

Serializable, Comparable<StatsCollectionState>

public enum StatsCollectionState
extends Enum<StatsCollectionState>

State of the StatsComponent.

Since:

0.8

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED State that disables stats collection.
ENABLED State that fully enables stats collection.

Method Summary

Modifier and Type	Method and Description
static StatsCollectionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatsCollectionState[]	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

ENABLED

public static final StatsCollectionState ENABLED

State that fully enables stats collection.

The StatsComponent collects stats for registered views.

Since:

0.8

DISABLED

public static final StatsCollectionState DISABLED

State that disables stats collection.

The StatsComponent does not need to collect stats for registered views and may return empty ViewDatas from ViewManager.getView(View.Name).

Since:

0.8

Method Detail

values

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

Returns:

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

valueOf

public static StatsCollectionState 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