Package org.glassfish.config.support

Enum CommandTarget

java.lang.Object

java.lang.Enum<CommandTarget>

org.glassfish.config.support.CommandTarget

All Implemented Interfaces:

Serializable, Comparable<CommandTarget>, TargetValidator

public enum CommandTarget
extends Enum<CommandTarget>
implements TargetValidator

CommandTarget is an enumeration of valid configuration target for a command execution

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLUSTER	a cluster configuration change
CLUSTERED_INSTANCE	a clustered instance configuration change
CONFIG	a config configuration change
DAS	configuration change to default server
DOMAIN	a domain wide configuration change
NODE	a node configuration change
STANDALONE_INSTANCE	a standalone instance configuration change

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a internalized aware string describing the target type
boolean	isValid(org.glassfish.hk2.api.ServiceLocator habitat, String target)	returns true if the passed target parameter value is a valid identifier of a target instance.
static CommandTarget	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommandTarget[]	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

DOMAIN

public static final CommandTarget DOMAIN

a domain wide configuration change

DAS

public static final CommandTarget DAS

configuration change to default server

CLUSTERED_INSTANCE

public static final CommandTarget CLUSTERED_INSTANCE

a clustered instance configuration change

STANDALONE_INSTANCE

public static final CommandTarget STANDALONE_INSTANCE

a standalone instance configuration change

CONFIG

public static final CommandTarget CONFIG

a config configuration change

CLUSTER

public static final CommandTarget CLUSTER

a cluster configuration change

NODE

public static final CommandTarget NODE

a node configuration change

Method Detail

values

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

Returns:

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

valueOf

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

isValid

public boolean isValid(org.glassfish.hk2.api.ServiceLocator habitat,
                       String target)

Description copied from interface: TargetValidator

returns true if the passed target parameter value is a valid identifier of a target instance.

Specified by:

isValid in interface TargetValidator

Parameters:

habitat - the habitat where to lookup all the target instances

target - the target identifier to check

Returns:

true if target is a valid identifier of a target instance

getDescription

public String getDescription()

Description copied from interface: TargetValidator

Returns a internalized aware string describing the target type

Specified by:

getDescription in interface TargetValidator

Returns:

a type description