AdventNet CLI 2.0 API Specification

com.adventnet.cli.messageset
Class InvalidCommandException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.adventnet.cli.messageset.InvalidCommandException

public class InvalidCommandException
extends java.lang.Exception

This class represents an Exception which is thrown whenever an error occurs while parsing the command.

See Also:
Serialized Form

Field Summary
static java.lang.String CMD_DATA_NOT_FOUND
          This error is thrown when the Data instance (CLIDataInstance) is not present (null) in the DataSet for a particular command that is used during the assembling of the command.
static java.lang.String CMD_INSUFFICIENT_PARAMS
          This error is thrown when the no of parameters provided is insufficient for a particular command being assembled.
static java.lang.String CMD_INVALID_DATA
          This error is thrown when the data from the DataInstance is of incorrect type.
static java.lang.String CMD_LONGOPTIONARGSNAME_MISMATCH
          This error is thrown when there is a mismatch between the long opts args name in a particular command and its Data instance.
static java.lang.String CMD_NAME_NOT_FOUND
          This error is thrown when the command Name is not present (null) in the commandSet for a particular command that is used during the assembling of the command.
static java.lang.String CMD_NOT_FOUND
          This error is thrown when the command identified by the command name is not present in the commandSet used during the assembling of the command.
static java.lang.String CMD_PARAMNAME_MISMATCH
          This error is thrown when there is a mismatch between the parameter name in a particular command and its Data instance.
static java.lang.String CMD_PATH_NOT_FOUND
          This error is thrown when the object List(path) specified is not present in the commandSet used during the assembling of the command.
static java.lang.String CMD_SIMPLEOPTIONARGSNAME_MISMATCH
          This error is thrown when there is a mismatch between the simple opts args name in a particular command and its Data instance.
 
Constructor Summary
InvalidCommandException()
          Constructs an InvalidCommandException with no detail message.
InvalidCommandException(java.lang.String message)
          Constructs an InvalidCommandException with the specified detail message.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CMD_NAME_NOT_FOUND

public static final java.lang.String CMD_NAME_NOT_FOUND
This error is thrown when the command Name is not present (null) in the commandSet for a particular command that is used during the assembling of the command.

CMD_NOT_FOUND

public static final java.lang.String CMD_NOT_FOUND
This error is thrown when the command identified by the command name is not present in the commandSet used during the assembling of the command.

CMD_PATH_NOT_FOUND

public static final java.lang.String CMD_PATH_NOT_FOUND
This error is thrown when the object List(path) specified is not present in the commandSet used during the assembling of the command.

CMD_DATA_NOT_FOUND

public static final java.lang.String CMD_DATA_NOT_FOUND
This error is thrown when the Data instance (CLIDataInstance) is not present (null) in the DataSet for a particular command that is used during the assembling of the command.

CMD_INSUFFICIENT_PARAMS

public static final java.lang.String CMD_INSUFFICIENT_PARAMS
This error is thrown when the no of parameters provided is insufficient for a particular command being assembled.

CMD_INVALID_DATA

public static final java.lang.String CMD_INVALID_DATA
This error is thrown when the data from the DataInstance is of incorrect type.

CMD_PARAMNAME_MISMATCH

public static final java.lang.String CMD_PARAMNAME_MISMATCH
This error is thrown when there is a mismatch between the parameter name in a particular command and its Data instance. This occurs during the assembling of the command using the DataSet and CommandSet.

CMD_SIMPLEOPTIONARGSNAME_MISMATCH

public static final java.lang.String CMD_SIMPLEOPTIONARGSNAME_MISMATCH
This error is thrown when there is a mismatch between the simple opts args name in a particular command and its Data instance. This occurs during the assembling of the command using the DataSet and CommandSet.

CMD_LONGOPTIONARGSNAME_MISMATCH

public static final java.lang.String CMD_LONGOPTIONARGSNAME_MISMATCH
This error is thrown when there is a mismatch between the long opts args name in a particular command and its Data instance. This occurs during the assembling of the command using the DataSet and CommandSet.
Constructor Detail

InvalidCommandException

public InvalidCommandException()
Constructs an InvalidCommandException with no detail message. A detail message is a String that describes this particular exception.

InvalidCommandException

public InvalidCommandException(java.lang.String message)
Constructs an InvalidCommandException with the specified detail message. A detail message is a String that describes this particular exception.
Parameters:
message - the detail message.

AdventNet CLI 2.0 API Specification