org.sonatype.gshell.command
Enum CommandAction.Result

java.lang.Object
  java.lang.Enum<CommandAction.Result>
      org.sonatype.gshell.command.CommandAction.Result

All Implemented Interfaces:

Serializable, Comparable<CommandAction.Result>

Enclosing interface:

CommandAction

public static enum CommandAction.Result
extends Enum<CommandAction.Result>

Enumeration for the basic return types of a command execution.

Enum Constant Summary

FAILURE
The command execution failed.

SUCCESS
The command execution was successful.

Method Summary

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

SUCCESS

public static final CommandAction.Result SUCCESS

The command execution was successful.

FAILURE

public static final CommandAction.Result FAILURE

The command execution failed.

Method Detail

values

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

Returns:

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

valueOf

public static CommandAction.Result 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