org.josef.util

Class InvalidArgumentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.josef.util.AbstractLocalizedException

org.josef.util.InvalidArgumentException

All Implemented Interfaces:

Serializable, Localizable

Direct Known Subclasses:

InvalidStateException

@Status(stage=PRODUCTION,
        unitTests=PARTIAL)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public class InvalidArgumentException
extends AbstractLocalizedException

Exception that signals that an argument passed to a method is not valid.
Resembles IllegalArgumentException but this is a checked and localizable exception.

Version:

1.0 $Revision: 6223 $

Author:

Kees Schotanus, Martijn Baels

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidArgumentException() Default constructor creates this exception with a standard, non localized message.
InvalidArgumentException(String message) Constructs an InvalidArgumentException using the supplied message.
InvalidArgumentException(String resourceBundleName, String messageKey, Object... messageArguments) Constructs an InvalidArgumentException from the supplied ResourceBundle name and the supplied message key and optional arguments.
InvalidArgumentException(Throwable cause, String message) Constructs an InvalidArgumentException using the supplied cause and message.
InvalidArgumentException(Throwable cause, String resourceBundleName, String messageKey, Object... messageArguments) Constructs an InvalidArgumentException from the supplied cause, ResourceBundle name, message key and optional arguments.

Method Summary

Methods inherited from class org.josef.util.AbstractLocalizedException

getDescription, getMessage, getMessage, getMessageArguments, getMessageKey, getResourceBundleName, toString

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidArgumentException

public InvalidArgumentException()

Default constructor creates this exception with a standard, non localized message.

InvalidArgumentException

public InvalidArgumentException(String message)

Constructs an InvalidArgumentException using the supplied message.
The message may be localized but in this case it is up to the programmer to supply the correct localized message.

Parameters:

message - Message with additional information about why the argument is invalid.

InvalidArgumentException

public InvalidArgumentException(Throwable cause,
                                String message)

Constructs an InvalidArgumentException using the supplied cause and message.
The message may be localized but in this case it is up to the programmer to supply the correct localized message.

Parameters:

cause - Exception that caused this exception.
May be null in which case this exception is not caused by another exception.

message - Message indicating why the exception occurred.

InvalidArgumentException

public InvalidArgumentException(String resourceBundleName,
                                String messageKey,
                                Object... messageArguments)

Constructs an InvalidArgumentException from the supplied ResourceBundle name and the supplied message key and optional arguments.
Use this constructor when your message contains one or more message arguments.

Parameters:

resourceBundleName - The name of the ResourceBundle that contains the localized messages.

messageKey - Key to the resource bundle to retrieve the localized message.

messageArguments - The optional message arguments that will be inserted into the localized message.

Throws:

IllegalArgumentException - When the supplied resourceBundleName or messageKey is empty.

NullPointerException - When the supplied resourceBundleName or messageKey is null.

InvalidArgumentException

public InvalidArgumentException(Throwable cause,
                                String resourceBundleName,
                                String messageKey,
                                Object... messageArguments)

Constructs an InvalidArgumentException from the supplied cause, ResourceBundle name, message key and optional arguments.
Use this constructor when your message contains one or more message arguments or when this exception is caused by another exception.

Parameters:

cause - Exception that caused this exception.
May be null in which case this exception is not caused by another exception.

resourceBundleName - The name of the ResourceBundle that contains the localized messages.

messageKey - Key to the resource bundle to retrieve the localized message.

messageArguments - The message arguments that will be inserted into the localized message.

Throws:

IllegalArgumentException - When the supplied resourceBundleName or messageKey is empty.

NullPointerException - When the supplied resourceBundleName or messageKey is null.