com.newrelic.agent.xml

Enum XmlInstrumentOptions

java.lang.Object

java.lang.Enum<XmlInstrumentOptions>

com.newrelic.agent.xml.XmlInstrumentOptions

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG_FLAG True means debug will be on and more information will be outputed to the command line.
FILE_PATH The path to the custom extension xml file.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the field description.
java.lang.String	getFlagName() Gets the field flagName.
boolean	isArgRequired() Gets the field required.
abstract void	validateAndAddParameter(XmlInstrumentParams instrument, java.lang.String[] value, java.lang.String tagName) Takes the input value and sets it on the instrument.
static XmlInstrumentOptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static XmlInstrumentOptions[]	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

FILE_PATH

public static final XmlInstrumentOptions FILE_PATH

The path to the custom extension xml file.

DEBUG_FLAG

public static final XmlInstrumentOptions DEBUG_FLAG

True means debug will be on and more information will be outputed to the command line.

Method Detail

values

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

Returns:

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

valueOf

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

validateAndAddParameter

public abstract void validateAndAddParameter(XmlInstrumentParams instrument,
                                             java.lang.String[] value,
                                             java.lang.String tagName)

Takes the input value and sets it on the instrument.

Parameters:

instrument - Where the values from the command line should be stored.

value - The current value.

tagName - The name to use in exceptions.

getFlagName

public java.lang.String getFlagName()

Gets the field flagName.

Returns:

the flagName

isArgRequired

public boolean isArgRequired()

Gets the field required.

Returns:

the required

getDescription

public java.lang.String getDescription()

Gets the field description.

Returns:

the description