com.atlassian.bitbucket.scm

Enum CommandResult

java.lang.Object

java.lang.Enum<CommandResult>

com.atlassian.bitbucket.scm.CommandResult

All Implemented Interfaces:

Serializable, Comparable<CommandResult>

public enum CommandResult
extends Enum<CommandResult>

Enumerates the possible results of running a command.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED The command was canceled, either by the requester or because it timed out.
FAILED The command failed.
SUCCEEDED The command succeeded.

Method Summary

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

CANCELED

public static final CommandResult CANCELED

The command was canceled, either by the requester or because it timed out. The process of canceling the command may have also caused other failures. If so, the system is ignoring them.

FAILED

public static final CommandResult FAILED

The command failed. This may mean it was never started due to environment or resource problems, or that it started and encountered an error during execution.

SUCCEEDED

public static final CommandResult SUCCEEDED

The command succeeded.

Method Detail

values

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

Returns:

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

valueOf

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