com.ibm.portal.resolver.exceptions
Class LocalizedIOException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by com.ibm.portal.resolver.exceptions.LocalizedIOException
All Implemented Interfaces:
Localized, LocalizedStatus, java.io.Serializable

public class LocalizedIOException
extends java.io.IOException
implements LocalizedStatus

Helper exception to wrap localization information into a SAXException

See Also:
Serialized Form

Field Summary
protected static int SC_DEFAULT
           
 
Constructor Summary
LocalizedIOException(java.lang.Exception aCause)
          Constructor used if no metainformation about the actual exception cause is known.
LocalizedIOException(int aStatus, java.lang.Exception aCause)
          Constructor used if no metainformation about the actual exception cause is known.
LocalizedIOException(Localized aDelegate, java.lang.Exception aCause)
           
LocalizedIOException(Localized aDelegate, int aStatus, java.lang.Exception aCause)
           
LocalizedIOException(LocalizedStatus aDelegate, java.lang.Exception aCause)
           
 
Method Summary
 java.lang.Throwable getCause()
           
 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
Constructor Detail

LocalizedIOException

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

Parameters:
aCause - the root exception

LocalizedIOException

public LocalizedIOException(int aStatus,
                            java.lang.Exception 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,
                            java.lang.Exception aCause)

LocalizedIOException

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

LocalizedIOException

public LocalizedIOException(LocalizedStatus aDelegate,
                            java.lang.Exception aCause)
Method Detail

getCause

public java.lang.Throwable getCause()
Overrides:
getCause in class java.lang.Throwable

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.