agi.foundation.compatibility

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

Class ArgumentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

agi.foundation.compatibility.ArgumentException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ArgumentNullException, ArgumentOutOfRangeException, ArgumentTypeInvalidException

public class ArgumentException
extends IllegalArgumentException

The exception that is thrown when one of the arguments provided to a method is not valid.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArgumentException() Initializes a new instance.
ArgumentException(String message) Initializes a new instance with a specified error message.
ArgumentException(String message, Exception cause) Initializes a new instance with a specified error message and a reference to the inner exception that is the cause of this exception.
ArgumentException(String message, String paramName) Initializes a new instance with a specified error message and the name of the parameter that causes this exception.
ArgumentException(String message, String paramName, Exception cause) Initializes a new instance with a specified error message, the parameter name, and a reference to the inner exception that is the cause of this exception.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Returns the detail message string of this throwable.
String	getParamName() Gets the name of the parameter that causes this exception.

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

ArgumentException

public ArgumentException()

Initializes a new instance.

ArgumentException

public ArgumentException(String message)

Initializes a new instance with a specified error message.

Parameters:

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

ArgumentException

public ArgumentException(String message,
                         Exception cause)

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

Parameters:

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

cause - The exception that is the cause of the current exception.

ArgumentException

public ArgumentException(String message,
                         String paramName)

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

Parameters:

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

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

ArgumentException

public ArgumentException(String message,
                         String paramName,
                         Exception cause)

Initializes a new instance with a specified error message, the parameter name, and a reference to the inner exception that is the cause of this exception.

Parameters:

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

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

cause - The exception that is the cause of the current exception.

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 Throwable

Returns:

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

getParamName

public String getParamName()

Gets the name of the parameter that causes this exception.

Returns:

The parameter name.