org.forgerock.i18n

Class LocalizedIllegalArgumentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.forgerock.i18n.LocalizedIllegalArgumentException

All Implemented Interfaces:

Serializable, LocalizableException

public class LocalizedIllegalArgumentException
extends IllegalArgumentException
implements LocalizableException

Thrown to indicate that a method has been passed an illegal or inappropriate argument.

A LocalizedIllegalArgumentException contains a localized error message which may be used to provide the user with detailed diagnosis information. The localized message can be retrieved using the getMessageObject() method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalizedIllegalArgumentException(LocalizableMessage message) Creates a new localized illegal argument exception with the provided message.
LocalizedIllegalArgumentException(LocalizableMessage message, Throwable cause) Creates a new localized illegal argument exception with the provided message and cause.

Method Summary

Modifier and Type	Method and Description
LocalizableMessage	getMessageObject() Returns the localizable message that explains the problem that occurred.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

LocalizedIllegalArgumentException

public LocalizedIllegalArgumentException(LocalizableMessage message)

Creates a new localized illegal argument exception with the provided message.

Parameters:

message - The message that explains the problem that occurred.

LocalizedIllegalArgumentException

public LocalizedIllegalArgumentException(LocalizableMessage message,
                                         Throwable cause)

Creates a new localized illegal argument exception with the provided message and cause.

Parameters:

message - The message that explains the problem that occurred.

cause - The cause which may be later retrieved by the Throwable.getCause() method. A null value is permitted, and indicates that the cause is nonexistent or unknown.

Method Detail

getMessageObject

public final LocalizableMessage getMessageObject()

Returns the localizable message that explains the problem that occurred.

Specified by:

getMessageObject in interface LocalizableException

Returns:

The localizable message that explains the problem that occurred.