org.jboss.as.controller.registry

Enum AttributeAccess.Flag

java.lang.Object

java.lang.Enum<AttributeAccess.Flag>

org.jboss.as.controller.registry.AttributeAccess.Flag

All Implemented Interfaces:

Serializable, Comparable<AttributeAccess.Flag>

Enclosing class:

AttributeAccess

public static enum AttributeAccess.Flag
extends Enum<AttributeAccess.Flag>

Flags to indicate special characteristics of an attribute

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIAS The attribute is an alias to something else
COUNTER_METRIC The attribute represents a Counter metric, a cumulative metric that represents a single monotonically increasing counter whose value can only increase or be reset to zero on restart.
EXPRESSIONS_DEPRECATED Support for use of an expression for the value of this attribute is deprecated and may be removed in a future release.
GAUGE_METRIC The attribute represents a Gauge metric, a single numerical value that can arbitrarily go up and down.
RESTART_ALL_SERVICES A modification to the attribute can only be applied to the runtime via a restart of all services, but does not require a full jvm restart
RESTART_JVM A modification to the attribute can only be applied to the runtime via a full jvm restart
RESTART_NONE A modification to the attribute can be applied to the runtime without requiring a restart
RESTART_RESOURCE_SERVICES A modification to the attribute can only be applied to the runtime via a restart of services, associated with the attribute's resource, but does not require a restart of all services or a full jvm restart
RUNTIME_SERVICE_NOT_REQUIRED An attribute which does not require runtime MSC services to be read or written.
STORAGE_CONFIGURATION An attribute whose value is stored in the persistent configuration.
STORAGE_RUNTIME An attribute whose value is only stored in runtime services, and isn't stored in the persistent configuration.

Method Summary

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

RESTART_NONE

public static final AttributeAccess.Flag RESTART_NONE

A modification to the attribute can be applied to the runtime without requiring a restart

RESTART_JVM

public static final AttributeAccess.Flag RESTART_JVM

A modification to the attribute can only be applied to the runtime via a full jvm restart

RESTART_ALL_SERVICES

public static final AttributeAccess.Flag RESTART_ALL_SERVICES

A modification to the attribute can only be applied to the runtime via a restart of all services, but does not require a full jvm restart

RESTART_RESOURCE_SERVICES

public static final AttributeAccess.Flag RESTART_RESOURCE_SERVICES

A modification to the attribute can only be applied to the runtime via a restart of services, associated with the attribute's resource, but does not require a restart of all services or a full jvm restart

STORAGE_CONFIGURATION

public static final AttributeAccess.Flag STORAGE_CONFIGURATION

An attribute whose value is stored in the persistent configuration. The value may also be stored in runtime services.

STORAGE_RUNTIME

public static final AttributeAccess.Flag STORAGE_RUNTIME

An attribute whose value is only stored in runtime services, and isn't stored in the persistent configuration.

ALIAS

public static final AttributeAccess.Flag ALIAS

The attribute is an alias to something else

RUNTIME_SERVICE_NOT_REQUIRED

public static final AttributeAccess.Flag RUNTIME_SERVICE_NOT_REQUIRED

An attribute which does not require runtime MSC services to be read or written. This flag can be used in conjunction with STORAGE_RUNTIME to specify that a runtime attribute can work in the absence of runtime services.

EXPRESSIONS_DEPRECATED

public static final AttributeAccess.Flag EXPRESSIONS_DEPRECATED

Support for use of an expression for the value of this attribute is deprecated and may be removed in a future release.

GAUGE_METRIC

public static final AttributeAccess.Flag GAUGE_METRIC

The attribute represents a Gauge metric, a single numerical value that can arbitrarily go up and down. If the attribute is registered as a metric without specifying the GAUGE_METRIC or COUNTER_METRIC flag, it is considered as a gauge. GAUGE_METRIC and COUNTER_METRIC are mutually exclusive.

COUNTER_METRIC

public static final AttributeAccess.Flag COUNTER_METRIC

The attribute represents a Counter metric, a cumulative metric that represents a single monotonically increasing counter whose value can only increase or be reset to zero on restart. GAUGE_METRIC and COUNTER_METRIC are mutually exclusive.

Method Detail

values

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

Returns:

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

valueOf

public static AttributeAccess.Flag 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

immutableSetOf

public static Set<AttributeAccess.Flag> immutableSetOf(AttributeAccess.Flag... flags)