com.ibm.as400.access
Class ExtendedIllegalArgumentException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              java.lang.IllegalArgumentException
                  com.ibm.as400.access.ExtendedIllegalArgumentException

All Implemented Interfaces:

ReturnCodeException, Serializable

public class ExtendedIllegalArgumentException
extends IllegalArgumentException
implements ReturnCodeException

The ExtendedIllegalArgumentException class represents an exception that indicates that an argument is not valid.

See Also:

Serialized Form

Field Summary

Modifier and Type	Field and Description
static int	FIELD_NOT_FOUND The return code indicating that the field was not found.
static int	LENGTH_NOT_VALID The return code indicating that the length is not valid.
static int	PARAMETER_VALUE_DATATYPE_NOT_VALID The return code indicating that the data type requested is not valid.
static int	PARAMETER_VALUE_NOT_VALID The return code indicating that the parameter value is not valid.
static int	PATH_NOT_VALID The return code indicating that the path is not valid.
static int	RANGE_NOT_VALID The return code indicating that the parameter value is out of the allowed range.
static int	SIGNON_CHAR_NOT_VALID The return code indicating that the user ID or password contains a character that is not valid.

Constructor and Description

ExtendedIllegalArgumentException(String argument, int returnCode)
Constructs an ExtendedIllegalArgumentException object.

Method Summary

Modifier and Type	Method and Description
int	getReturnCode() Returns the return code associated with this exception.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LENGTH_NOT_VALID

public static final int LENGTH_NOT_VALID

The return code indicating that the length is not valid.

See Also:

Constant Field Values

PARAMETER_VALUE_NOT_VALID

public static final int PARAMETER_VALUE_NOT_VALID

The return code indicating that the parameter value is not valid.

See Also:

Constant Field Values

PATH_NOT_VALID

public static final int PATH_NOT_VALID

The return code indicating that the path is not valid.

See Also:

Constant Field Values

RANGE_NOT_VALID

public static final int RANGE_NOT_VALID

The return code indicating that the parameter value is out of the allowed range.

See Also:

Constant Field Values

FIELD_NOT_FOUND

public static final int FIELD_NOT_FOUND

The return code indicating that the field was not found.

See Also:

Constant Field Values

SIGNON_CHAR_NOT_VALID

public static final int SIGNON_CHAR_NOT_VALID

The return code indicating that the user ID or password contains a character that is not valid.

See Also:

Constant Field Values

PARAMETER_VALUE_DATATYPE_NOT_VALID

public static final int PARAMETER_VALUE_DATATYPE_NOT_VALID

The return code indicating that the data type requested is not valid.

See Also:

Constant Field Values

Constructor Detail

ExtendedIllegalArgumentException

public ExtendedIllegalArgumentException(String argument,
                                        int returnCode)

Constructs an ExtendedIllegalArgumentException object. It indicates that a method has been passed an illegal argument.

Parameters:

argument - The type and value of the argument that was illegal. It should be in the format: argument (value). For example: library (mylib).

returnCode - The return code which identifies the message to be returned.

Method Detail

getReturnCode

public int getReturnCode()

Returns the return code associated with this exception.

Specified by:

getReturnCode in interface ReturnCodeException

Returns:

The return code.