com.googlecode.jmxtrans.model

Enum ResultAttribute

java.lang.Object

java.lang.Enum<ResultAttribute>

com.googlecode.jmxtrans.model.ResultAttribute

All Implemented Interfaces:

Serializable, Comparable<ResultAttribute>

public enum ResultAttribute
extends Enum<ResultAttribute>

Enumerates the attributes of Result

Author:

Simon Hutchinson github.com/sihutch

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTRIBUTE_NAME
CLASS_NAME
OBJ_DOMAIN
TYPE_NAME

Method Summary

Modifier and Type	Method and Description
void	addAttribute(Map<String,String> attributeMap, Result result) Calls the Getter defined by the ResultAttribute on the Result add adds the entry to the supplied Map
static ResultAttribute	fromAttribute(String attributeName) Get the ResultAttribute value from the attribute name
static ResultAttribute	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResultAttribute[]	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

TYPE_NAME

public static final ResultAttribute TYPE_NAME

OBJ_DOMAIN

public static final ResultAttribute OBJ_DOMAIN

CLASS_NAME

public static final ResultAttribute CLASS_NAME

ATTRIBUTE_NAME

public static final ResultAttribute ATTRIBUTE_NAME

Method Detail

values

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

Returns:

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

valueOf

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

fromAttribute

public static ResultAttribute fromAttribute(@Nonnull
                                            String attributeName)

Get the ResultAttribute value from the attribute name

Parameters:

attributeName -

The attribute name for the ResultAttribute allowed values are:

• typeName
• objDomain
• className
• attributeName

Returns:

the ResultAttribute

addAttribute

public void addAttribute(@Nonnull
                         Map<String,String> attributeMap,
                         @Nonnull
                         Result result)

Calls the Getter defined by the ResultAttribute on the Result add adds the entry to the supplied Map

Parameters:

attributeMap - The map to add the Result data to

result - The Result to get the data from