org.josef.util

Class InvalidStateException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.josef.util.AbstractLocalizedException

org.josef.util.InvalidArgumentException

org.josef.util.InvalidStateException

All Implemented Interfaces:

Serializable, Localizable

@Status(stage=DEVELOPMENT,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public class InvalidStateException
extends InvalidArgumentException

Exception that signals that an object like a ValueObject is in an invalid state.
Resembles IllegalStateException but this exception is both checked and localizable.
Technical note: This class extends InvalidArgument exception to be compatible with a previous implementation in jxpfw. The rule of thumb remains: Use InvalidArgument to check for arguments passed to a method. For validation and state of an object in general, use InvalidStateException. Unfortunately this can't be enforced now due to inheritance.

Version:

1.0 $Revision: 6223 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

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

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

InvalidStateException

public InvalidStateException()

Default constructor creates an InvalidStateException with a standard, non localized message.

InvalidStateException

public InvalidStateException(String message)

Constructs an InvalidStateException 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 object is in an invalid state.

InvalidStateException

public InvalidStateException(AbstractLocalizedException exception)

Constructs an InvalidStateException from the supplied exception.
Note: The supplied exception must be an exception that contains both a resource bundle name and a message key.

Parameters:

exception - The exception to create this InvalidStateException from.

Throws:

NullPointerException - When the supplied exception contains a null resource bundle name or a null message key.

InvalidStateException

public InvalidStateException(Throwable cause,
                             String message)

Constructs an InvalidStateException 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.

InvalidStateException

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

Constructs an InvalidStateException from the supplied ResourceBundle name and the supplied message key and optional arguments.
Use this constructor when your message contains one or more 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 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.

InvalidStateException

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

Constructs an InvalidStateException from the supplied ResourceBundle name, the supplied message key, optional arguments and optional cause.
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.