net.obvj.agents.conf

Enum AgentConfiguration.Source

java.lang.Object

java.lang.Enum<AgentConfiguration.Source>

net.obvj.agents.conf.AgentConfiguration.Source

All Implemented Interfaces:

Serializable, Comparable<AgentConfiguration.Source>

Enclosing class:

AgentConfiguration

public static enum AgentConfiguration.Source
extends Enum<AgentConfiguration.Source>

Enumerates supported configuration sources and their precedence levels.

Author:

oswaldo.bapvic.jr

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATION The source applicable for configuration performed via the Agent annotation.
DEFAULT The source applicable for configuration performed programmatically.
XML The source applicable for configuration via XML file.

Method Summary

Modifier and Type	Method and Description
static AgentConfiguration.Source	getHighestPrecedenceSource(AgentConfiguration.Source... sources) Returns the source with the highest precedence level among the specified sources
int	getPrecedence() Returns the precedence level for this source, ordered from highest to lowest, so that higher-level sources have more precedence/importance than the other ones.
static AgentConfiguration.Source	valueOf(String name) Returns the enum constant of this type with the specified name.
static AgentConfiguration.Source[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANNOTATION

public static final AgentConfiguration.Source ANNOTATION

The source applicable for configuration performed via the Agent annotation.

DEFAULT

public static final AgentConfiguration.Source DEFAULT

The source applicable for configuration performed programmatically.

XML

public static final AgentConfiguration.Source XML

The source applicable for configuration via XML file.

Method Detail

values

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

Returns:

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

valueOf

public static AgentConfiguration.Source 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

getHighestPrecedenceSource

public static AgentConfiguration.Source getHighestPrecedenceSource(AgentConfiguration.Source... sources)

Returns the source with the highest precedence level among the specified sources

Parameters:

sources - an array of sources to be evaluated

Returns:

the source with the highest precedence level among the specified sources, or DEFAULT if no parameter specified

getPrecedence

public int getPrecedence()

Returns the precedence level for this source, ordered from highest to lowest, so that higher-level sources have more precedence/importance than the other ones.

Returns:

the precedence level for this source