org.rhq.core.pluginapi.inventory

Enum ResourceDiscoveryCallback.DiscoveryCallbackResults

java.lang.Object

java.lang.Enum<ResourceDiscoveryCallback.DiscoveryCallbackResults>

org.rhq.core.pluginapi.inventory.ResourceDiscoveryCallback.DiscoveryCallbackResults

All Implemented Interfaces:

Serializable, Comparable<ResourceDiscoveryCallback.DiscoveryCallbackResults>

Enclosing interface:

ResourceDiscoveryCallback

public static enum ResourceDiscoveryCallback.DiscoveryCallbackResults
extends Enum<ResourceDiscoveryCallback.DiscoveryCallbackResults>

Enum Constant Summary

Enum Constants

Enum Constant and Description
PROCESSED If the callback recognized the discovered resource, it should return this enum value to let the plugin container know that the details were processed by this callback and were possibly altered from their original state.
UNPROCESSED If the callback left the discovered details as-is, it should return this enum value.
VETO If the callback determines that the discovered resource is invalid or for some reason should not go into inventory, it can veto its discovery via this enum value.

Method Summary

Methods

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

UNPROCESSED

public static final ResourceDiscoveryCallback.DiscoveryCallbackResults UNPROCESSED

If the callback left the discovered details as-is, it should return this enum value. The callback should only return this value if it did not alter any details data; if it did, it should return PROCESSED instead.

PROCESSED

public static final ResourceDiscoveryCallback.DiscoveryCallbackResults PROCESSED

If the callback recognized the discovered resource, it should return this enum value to let the plugin container know that the details were processed by this callback and were possibly altered from their original state. If more than one callback returned this enum for the same discovered resource details, the discovery for that resource will be aborted and it will not go into inventory. Multiple plugin callbacks cannot claim ownership of the same resource details and return this enum value.

VETO

public static final ResourceDiscoveryCallback.DiscoveryCallbackResults VETO

If the callback determines that the discovered resource is invalid or for some reason should not go into inventory, it can veto its discovery via this enum value.

Method Detail

values

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

Returns:

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

valueOf

public static ResourceDiscoveryCallback.DiscoveryCallbackResults 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