org.glassfish.api.admin

Enum FailurePolicy

java.lang.Object

java.lang.Enum<FailurePolicy>

org.glassfish.api.admin.FailurePolicy

All Implemented Interfaces:

Serializable, Comparable<FailurePolicy>

public enum FailurePolicy
extends Enum<FailurePolicy>

Defines the expected behaviour from the system when a supplemental command (could be a local or remote invocation) fails to execute properly.

Author:

Jerome Dochez

Enum Constant Summary

Enum Constants

Enum Constant and Description
Error Return an error exit code to the user but do not rollback any successful invocations of the commands.
Ignore Ignore the failure, do not report to the user.
Warn Warn the user of the failure, does not change the overall exit code of the command execution.

Method Summary

Modifier and Type	Method and Description
static ActionReport.ExitCode	applyFailurePolicy(FailurePolicy f, ActionReport.ExitCode e)
static FailurePolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static FailurePolicy[]	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

Ignore

public static final FailurePolicy Ignore

Ignore the failure, do not report to the user.

Warn

public static final FailurePolicy Warn

Warn the user of the failure, does not change the overall exit code of the command execution.

Error

public static final FailurePolicy Error

Return an error exit code to the user but do not rollback any successful invocations of the commands.

Method Detail

values

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

Returns:

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

valueOf

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

applyFailurePolicy

public static ActionReport.ExitCode applyFailurePolicy(FailurePolicy f,
                                                       ActionReport.ExitCode e)