org.rhq.core.domain.resource
Enum ResourceAncestryFormat

java.lang.Object
  java.lang.Enum<ResourceAncestryFormat>
      org.rhq.core.domain.resource.ResourceAncestryFormat

All Implemented Interfaces:

Serializable, Comparable<ResourceAncestryFormat>

public enum ResourceAncestryFormat
extends Enum<ResourceAncestryFormat>

Used to request the desired diplay format for resource ancestry.

Enum Constant Summary

EXTENDED

RAW
RAW: The raw, encoded value.

SIMPLE

VERBOSE

Method Summary

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

RAW

public static final ResourceAncestryFormat RAW

• RAW: The raw, encoded value. This is already provided by the Resource.ancestry field.
• SIMPLE: Short, name only format: (eg. parentName < grandParentName < etc...)
• EXTENDED: Prepends resource name to SIMPLE format: (eg. resourceName < parentName < grandParentName < etc...)
• VERBOSE: Verbose, MultiLine format incorporating name, type and indentation.

SIMPLE

public static final ResourceAncestryFormat SIMPLE

EXTENDED

public static final ResourceAncestryFormat EXTENDED

VERBOSE

public static final ResourceAncestryFormat VERBOSE

Method Detail

values

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

Returns:

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

valueOf

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