org.opends.server.tools
Enum JavaPropertiesTool.ErrorReturnCode

java.lang.Object
  extended by java.lang.Enum<JavaPropertiesTool.ErrorReturnCode>
      extended by org.opends.server.tools.JavaPropertiesTool.ErrorReturnCode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<JavaPropertiesTool.ErrorReturnCode>
Enclosing class:
JavaPropertiesTool

public static enum JavaPropertiesTool.ErrorReturnCode
extends java.lang.Enum<JavaPropertiesTool.ErrorReturnCode>

The enumeration containing the different return codes that the command-line can have.


Enum Constant Summary
ERROR_UNEXPECTED
          Unexpected error (potential bug).
ERROR_USER_DATA
          Cannot parse arguments or data provided by user is not valid.
ERROR_WRITING_FILE
          Error writing to destination file.
SUCCESSFUL
          Successful setup.
SUCCESSFUL_NOP
          We did no have an error but the setup was not executed (displayed version or usage).
 
Method Summary
 int getReturnCode()
          Get the corresponding return code value.
static JavaPropertiesTool.ErrorReturnCode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static JavaPropertiesTool.ErrorReturnCode[] 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

SUCCESSFUL

public static final JavaPropertiesTool.ErrorReturnCode SUCCESSFUL
Successful setup.


SUCCESSFUL_NOP

public static final JavaPropertiesTool.ErrorReturnCode SUCCESSFUL_NOP
We did no have an error but the setup was not executed (displayed version or usage).


ERROR_UNEXPECTED

public static final JavaPropertiesTool.ErrorReturnCode ERROR_UNEXPECTED
Unexpected error (potential bug).


ERROR_USER_DATA

public static final JavaPropertiesTool.ErrorReturnCode ERROR_USER_DATA
Cannot parse arguments or data provided by user is not valid.


ERROR_WRITING_FILE

public static final JavaPropertiesTool.ErrorReturnCode ERROR_WRITING_FILE
Error writing to destination file.

Method Detail

values

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

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

valueOf

public static JavaPropertiesTool.ErrorReturnCode valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getReturnCode

public int getReturnCode()
Get the corresponding return code value.

Returns:
The corresponding return code value.