com.ibm.websphere.management.cmdframework

Class InvalidParameterValueException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended bycom.ibm.ws.exception.WsException
  5. extended bycom.ibm.websphere.management.exception.AdminException
  6. extended bycom.ibm.websphere.management.cmdframework.CommandException
  7. extended bycom.ibm.websphere.management.cmdframework.CommandValidationException
  8. extended bycom.ibm.websphere.management.cmdframework.InvalidParameterValueException
All implemented interfaces:
com.ibm.ws.exception.WsNestedException, java.io.Serializable

  1. public class InvalidParameterValueException
  2. extends CommandValidationException
See Also:
Serialized Form

Field Summary

Fields inherited from class com.ibm.websphere.management.cmdframework.CommandException
nls

Constructor Summary

Constructor and Description
InvalidParameterValueException(java.lang.String cmdName,java.lang.String paramName,java.lang.Object paramVal)
Use this constructor if there is no additional information that needs to be explain about the cause of the exception, or use InvalidParameterValueException(String, String, Object, String) constructor if there is any additional information.
InvalidParameterValueException(java.lang.String cmdName,java.lang.String paramName,java.lang.Object paramVal,java.lang.String additionalInfo)
Use this constructor if there is any additional information that needs to be explain about the cause of the exception.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getMessage()
Access method to get the formatted message.
  1. java.lang.String
getParamName()
Access method for the paramName property.
  1. java.lang.Object
getValue()
Access method for the value property.
Methods inherited from class com.ibm.websphere.management.exception.AdminException
getAdminException, printStackTrace, printStackTrace
Methods inherited from class com.ibm.ws.exception.WsException
getCause, initCause
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidParameterValueException

  1. public InvalidParameterValueException( java.lang.String cmdName,
  2. java.lang.String paramName,
  3. java.lang.Object paramVal)
Use this constructor if there is no additional information that needs to be explain about the cause of the exception, or use InvalidParameterValueException(String, String, Object, String) constructor if there is any additional information.
Parameters:
cmdName - is the command name.
paramName - is the parameter name.
paramVal - is the parameter value.

InvalidParameterValueException

  1. public InvalidParameterValueException( java.lang.String cmdName,
  2. java.lang.String paramName,
  3. java.lang.Object paramVal,
  4. java.lang.String additionalInfo)
Use this constructor if there is any additional information that needs to be explain about the cause of the exception. Otherwise, use InvalidParameterValueException(String, String, Object) constructor instead. Caller who constructs this exception is responsible to provide NLS enabled message in the additional information.
Parameters:
cmdName - is the command name.
paramName - is the parameter name.
paramVal - is the parameter value.
additionalInfo - is the additional information to explain about the cause of the exception.

Method Detail

getParamName

  1. public java.lang.String getParamName( )
Access method for the paramName property.
Returns:
the current value of the paramName property

getValue

  1. public java.lang.Object getValue( )
Access method for the value property.
Returns:
the current value of the value property

getMessage

  1. public java.lang.String getMessage( )
Access method to get the formatted message.
Overrides:
getMessage in class java.lang.Throwable
Returns:
the formatted message of this exception.