com.gemstone.gemfire.management.cli
Class CommandProcessingException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              com.gemstone.gemfire.management.cli.CommandProcessingException

All Implemented Interfaces:

Serializable

public class CommandProcessingException
extends RuntimeException

Indicates exceptions while processing a GemFire Command Line Interface (CLI) commands. The exceptions could be due to

• parsing errors due to unknown parameters
• errors due to wrong values for the parameters

Since:

7.0

See Also:

Serialized Form

Field Summary

static int	ARGUMENT_INVALID Error Type indicating invalid parameter of a command
static int	COMMAND_INVALID Error Type indicating an invalid command
static int	COMMAND_INVALID_OR_UNAVAILABLE Error Type indicating an unknown or unavailable command.
static int	COMMAND_NAME_AMBIGUOUS Error Type indicating ambiguous command names
static int	OPTION_INVALID Error Type indicating invalid named parameter of a command
static int	OPTION_VALUE_INVALID Error Type indicating invalid value for a parameter of a command
static int	OPTION_VALUE_REQUIRED Error Type indicating absence of value for named parameter of a command
static int	REQUIRED_ARGUMENT_MISSING Error Type indicating absence of a mandatory parameter of a command
static int	REQUIRED_OPTION_MISSING Error Type indicating absence of a mandatory named parameter of a command
static int	RESOURCE_ACCESS_ERROR Error Type indicating IO errors while accessing File/Network resource

Constructor Summary

CommandProcessingException(String message, int errorType, Object errorData)
Constructs a new CommandProcessingException

Method Summary

Object	getErrorData() Returns the errorData associated with this CommandProcessingException instance
int	getErrorType() Returns the errorType for this CommandProcessingException instance
String	toString() Returns String representation of this CommandProcessingException

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMMAND_INVALID

public static int COMMAND_INVALID

Error Type indicating an invalid command

COMMAND_NAME_AMBIGUOUS

public static int COMMAND_NAME_AMBIGUOUS

Error Type indicating ambiguous command names

COMMAND_INVALID_OR_UNAVAILABLE

public static int COMMAND_INVALID_OR_UNAVAILABLE

Error Type indicating an unknown or unavailable command. GemFire CLI Commands are context sensitive & might not be always available

OPTION_INVALID

public static int OPTION_INVALID

Error Type indicating invalid named parameter of a command

ARGUMENT_INVALID

public static int ARGUMENT_INVALID

Error Type indicating invalid parameter of a command

OPTION_VALUE_INVALID

public static int OPTION_VALUE_INVALID

Error Type indicating invalid value for a parameter of a command

REQUIRED_OPTION_MISSING

public static int REQUIRED_OPTION_MISSING

Error Type indicating absence of a mandatory named parameter of a command

REQUIRED_ARGUMENT_MISSING

public static int REQUIRED_ARGUMENT_MISSING

Error Type indicating absence of a mandatory parameter of a command

OPTION_VALUE_REQUIRED

public static int OPTION_VALUE_REQUIRED

Error Type indicating absence of value for named parameter of a command

RESOURCE_ACCESS_ERROR

public static int RESOURCE_ACCESS_ERROR

Error Type indicating IO errors while accessing File/Network resource

Constructor Detail

CommandProcessingException

public CommandProcessingException(String message,
                                  int errorType,
                                  Object errorData)

Constructs a new CommandProcessingException

Parameters:

message - error message

errorType - one of the error types defined by CommandProcessingException

errorData - additional information about the error

Method Detail

getErrorType

public int getErrorType()

Returns the errorType for this CommandProcessingException instance

Returns:

the errorType for this CommandProcessingException instance

getErrorData

public Object getErrorData()

Returns the errorData associated with this CommandProcessingException instance

Returns:

the errorData associated with this CommandProcessingException instance

toString

public String toString()

Returns String representation of this CommandProcessingException

Overrides:

toString in class Throwable

Returns:

String representation of this CommandProcessingException