com.dynatrace.oneagent.sdk.api.enums
Enum SDKState

java.lang.Object
  java.lang.Enum<SDKState>
      com.dynatrace.oneagent.sdk.api.enums.SDKState

All Implemented Interfaces:

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

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

Defines the possible states of the SDK.

Enum Constant Summary

ACTIVE
SDK is connected to OneAgent and capturing data.

PERMANENTLY_INACTIVE
SDK isn't connected to OneAgent, so it will never capture data.

TEMPORARILY_INACTIVE
SDK is connected to OneAgent, but capturing is disabled.It is good practice to skip creating SDK transactions to save resources.

Method Summary

static SDKState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SDKState[]	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

ACTIVE

public static final SDKState ACTIVE

SDK is connected to OneAgent and capturing data.

Since:

1.0

TEMPORARILY_INACTIVE

public static final SDKState TEMPORARILY_INACTIVE

SDK is connected to OneAgent, but capturing is disabled.It is good practice to skip creating SDK transactions to save resources. The SDK state should be checked regularly as it may change at every point in time.

Since:

1.0

PERMANENTLY_INACTIVE

public static final SDKState PERMANENTLY_INACTIVE

SDK isn't connected to OneAgent, so it will never capture data. This SDK state will never change during the lifetime of a JVM. It is good practice to never call any SDK API to save resources.

Since:

1.0

Method Detail

values

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

Returns:

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

valueOf

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