com.sun.identity.common.configuration

Class UnknownPropertyNameException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.common.configuration.UnknownPropertyNameException

All Implemented Interfaces:

L10NMessage, Serializable

public class UnknownPropertyNameException
extends Exception
implements L10NMessage

Unknown property name exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnknownPropertyNameException(String message) Constructs a UnknownPropertyNameException with a detailed message.
UnknownPropertyNameException(String errorCode, Object[] args) This constructor is used to pass the localized error message At this level, the locale of the caller is not known and it is not possible to throw localized error message at this level.

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Returns error code associated with this error message.
String	getL10NMessage(Locale locale) Use this method to get localized error message directly.
String	getMessage() Use this method to get error message in default ENGLISH locale.
Object[]	getMessageArgs() Returns arguments for formatting this error message.
String	getResourceBundleName() Returns resource bundle name associated with this error message.

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

UnknownPropertyNameException

public UnknownPropertyNameException(String errorCode,
                                    Object[] args)

This constructor is used to pass the localized error message At this level, the locale of the caller is not known and it is not possible to throw localized error message at this level. Instead this constructor provides Resource Bundle name and errorCode for correctly locating the error messsage. The default getMessage() will always return English messages only. This is in consistent with current JRE

Parameters:

errorCode - Key to resource bundle. You can use String localizedStr = rb.getString(errorCode)

args - arguments to message. If it is not present pass the as null be displayed according to user's preferred locale.

UnknownPropertyNameException

public UnknownPropertyNameException(String message)

Constructs a UnknownPropertyNameException with a detailed message.

Parameters:

message - Exception Message. Detailed message for this exception.

Method Detail

getResourceBundleName

public String getResourceBundleName()

Returns resource bundle name associated with this error message.

Specified by:

getResourceBundleName in interface L10NMessage

Returns:

resource bundle name associated with this error message.

getErrorCode

public String getErrorCode()

Returns error code associated with this error message.

Specified by:

getErrorCode in interface L10NMessage

Returns:

error code associated with this error message.

getMessageArgs

public Object[] getMessageArgs()

Returns arguments for formatting this error message. You need to use MessageFormat class to format the message It can be null.

Specified by:

getMessageArgs in interface L10NMessage

Returns:

arguments for formatting this error message.

getMessage

public String getMessage()

Description copied from interface: L10NMessage

Use this method to get error message in default ENGLISH locale.

Specified by:

getMessage in interface L10NMessage

Overrides:

getMessage in class Throwable

Returns:

gets error message

getL10NMessage

public String getL10NMessage(Locale locale)

Description copied from interface: L10NMessage

Use this method to get localized error message directly.

Specified by:

getL10NMessage in interface L10NMessage

Parameters:

locale - Locale of the error message.

Returns:

localized error message.