agi.foundation.compatibility

(agi.foundation.core-2024r2.jar)

Class ArgumentOutOfRangeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

agi.foundation.compatibility.ArgumentException

agi.foundation.compatibility.ArgumentOutOfRangeException

All Implemented Interfaces:

Serializable

public class ArgumentOutOfRangeException
extends ArgumentException

The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArgumentOutOfRangeException() Initializes a new instance.
ArgumentOutOfRangeException(String paramName) Initializes a new instance with the name of the parameter that causes this exception.
ArgumentOutOfRangeException(String message, Exception cause) Initializes a new instance with a specified error message and the exception that is the cause of this exception.
ArgumentOutOfRangeException(String paramName, Object actualValue, String message) Initializes a new instance with a specified error message, the parameter name, and the value of the argument.
ArgumentOutOfRangeException(String paramName, String message) Initializes a new instance with a specified error message and the name of the parameter that causes this exception.

Method Summary

Modifier and Type	Method and Description
Object	getActualValue() Gets the argument value that causes this exception.
String	getMessage() Returns the detail message string of this throwable.

Methods inherited from class agi.foundation.compatibility.ArgumentException

getParamName

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentOutOfRangeException

public ArgumentOutOfRangeException()

Initializes a new instance.

ArgumentOutOfRangeException

public ArgumentOutOfRangeException(String paramName)

Initializes a new instance with the name of the parameter that causes this exception.

Parameters:

paramName - The name of the parameter that causes this exception.

ArgumentOutOfRangeException

public ArgumentOutOfRangeException(String message,
                                   Exception cause)

Initializes a new instance with a specified error message and the exception that is the cause of this exception.

Parameters:

message - The error message that explains the reason for this exception.

cause - The exception that is the cause of the current exception, or a null reference if no inner exception is specified.

ArgumentOutOfRangeException

public ArgumentOutOfRangeException(String paramName,
                                   String message)

Initializes a new instance with a specified error message and the name of the parameter that causes this exception.

Parameters:

paramName - The name of the parameter that caused the exception.

message - The message that describes the error.

ArgumentOutOfRangeException

public ArgumentOutOfRangeException(String paramName,
                                   Object actualValue,
                                   String message)

Initializes a new instance with a specified error message, the parameter name, and the value of the argument.

Parameters:

paramName - The name of the parameter that caused the exception.

actualValue - The value of the argument that causes this exception.

message - The message that describes the error.

Method Detail

getMessage

public String getMessage()

Description copied from class: java.lang.Throwable

Returns the detail message string of this throwable.

Overrides:

getMessage in class ArgumentException

Returns:

the detail message string of this Throwable instance (which may be null).

getActualValue

public Object getActualValue()

Gets the argument value that causes this exception.

Returns:

An Object that contains the value of the parameter that caused the current Exception.