com.ibm.portal.resolver.exceptions
Class LocalizedIOException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.io.IOException
              com.ibm.portal.resolver.exceptions.LocalizedIOException

All Implemented Interfaces:

Localized, LocalizedStatus, Constants, java.io.Serializable

Direct Known Subclasses:

MessageCodeIOException

public class LocalizedIOException
extends java.io.IOException
implements LocalizedStatus, Constants

Helper exception to wrap localization information into a SAXException

Since:

7.0

See Also:

Serialized Form

Field Summary

protected static int

SC_DEFAULT default status code

Fields inherited from interface com.ibm.portal.resolver.exceptions.Constants

SC_BAD_REQUEST, SC_GONE, SC_INTERNAL_SERVER_ERROR, SC_NOT_FOUND, SC_REQUEST_TIMEOUT, SC_SERVICE_UNAVAILABLE, SC_UNAUTHORIZED

Constructor Summary

LocalizedIOException()

LocalizedIOException(int aStatus, java.lang.Throwable aCause)
Constructor used if no metainformation about the actual exception cause is known.

LocalizedIOException(Localized aDelegate, int aStatus)

LocalizedIOException(Localized aDelegate, int aStatus, java.lang.Throwable aCause)

LocalizedIOException(LocalizedStatus aDelegate, java.lang.Throwable aCause)
Initializes the exception based on a localize status and a root cause

LocalizedIOException(Localized aDelegate, java.lang.Throwable aCause)

LocalizedIOException(java.lang.Throwable aCause)
Constructor used if no metainformation about the actual exception cause is known.

Method Summary

java.lang.Throwable	getCause()
protected LocalizedStatus	getDelegate() Returns the localized status to delegate the translation to
java.lang.String	getDescription(java.util.Locale aLocale) Returns the description of this object in the given locale.
ListModel<java.util.Locale>	getLocales() Returns a list model containing the locales that are supported by this object.
java.lang.String	getLocalizedMessage()
java.lang.String	getMessage()
int	getStatus() Returns a status code that can be evaluated by the handler of the exception implementing LocalizedStatus.
java.lang.String	getTitle(java.util.Locale aLocale) Returns the title of this object in the given locale.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

SC_DEFAULT

protected static final int SC_DEFAULT

default status code

See Also:

Constant Field Values

Constructor Detail

LocalizedIOException

public LocalizedIOException()

LocalizedIOException

public LocalizedIOException(int aStatus,
                            java.lang.Throwable aCause)

Constructor used if no metainformation about the actual exception cause is known.

Parameters:

aStatus - status code of the exception

aCause - the actual root cause

LocalizedIOException

public LocalizedIOException(Localized aDelegate,
                            int aStatus)

LocalizedIOException

public LocalizedIOException(Localized aDelegate,
                            int aStatus,
                            java.lang.Throwable aCause)

LocalizedIOException

public LocalizedIOException(Localized aDelegate,
                            java.lang.Throwable aCause)

LocalizedIOException

public LocalizedIOException(LocalizedStatus aDelegate,
                            java.lang.Throwable aCause)

Initializes the exception based on a localize status and a root cause

Parameters:

aDelegate - the localization delegate, not null

aCause - the exception cause, may be null

LocalizedIOException

public LocalizedIOException(java.lang.Throwable aCause)

Constructor used if no metainformation about the actual exception cause is known.

Parameters:

aCause - the root exception

Method Detail

getCause

public java.lang.Throwable getCause()

Overrides:

getCause in class java.lang.Throwable

getDelegate

protected LocalizedStatus getDelegate()

Returns the localized status to delegate the translation to

Returns:

the localized status, not null

getDescription

public java.lang.String getDescription(java.util.Locale aLocale)

Description copied from interface: Localized

Returns the description of this object in the given locale.

Specified by:

getDescription in interface Localized

Parameters:

aLocale - the locale for which to retrieve the description, must not be null.

Returns:

the description of this node in the given locale. If a description is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism

getLocales

public ListModel<java.util.Locale> getLocales()

Description copied from interface: Localized

Returns a list model containing the locales that are supported by this object. The presence of a locale in this list does not mean that a title and description is available, but rather that either one or both are available in that locale.

Specified by:

getLocales in interface Localized

Returns:

a list of locales defined for this object, returns an empty ListModel if no locales are supported.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getStatus

public int getStatus()

Description copied from interface: LocalizedStatus

Returns a status code that can be evaluated by the handler of the exception implementing LocalizedStatus. It is up to the handler of the exception how to interpret the status code.

Specified by:

getStatus in interface LocalizedStatus

Returns:

a status code

getTitle

public java.lang.String getTitle(java.util.Locale aLocale)

Description copied from interface: Localized

Returns the title of this object in the given locale.

Specified by:

getTitle in interface Localized

Parameters:

aLocale - the locale for which to retrieve the title, must not be null.

Returns:

the title of this node in the given locale. If a title is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism.