com.ibm.portal.resolver.exceptions
Class MessageCodeSAXException
java.lang.Object
   java.lang.Throwable
java.lang.Throwable
       java.lang.Exception
java.lang.Exception
           org.xml.sax.SAXException
org.xml.sax.SAXException
               com.ibm.portal.resolver.exceptions.LocalizedSAXException
com.ibm.portal.resolver.exceptions.LocalizedSAXException
                   com.ibm.portal.resolver.exceptions.MessageCodeSAXException
com.ibm.portal.resolver.exceptions.MessageCodeSAXException
- All Implemented Interfaces: 
- Localized, LocalizedStatus, Constants, java.io.Serializable
- 
public abstract class MessageCodeSAXException 
- extends LocalizedSAXException
IOException wrapped into a SAXException
- Since:
- 8.0
- See Also:
- Serialized Form
| Field Summary | 
| protected static java.lang.Object[] | EMPTY_PARAMETERS the empty set of parameters, can be used for messages without params
 | 
 
 
 
 
| Method Summary | 
| ListModel<java.util.Locale> | getLocales() Return a list model containing the locales that are supported by this
 object.
 | 
| java.lang.String | getLocalizedMessage() 
 | 
| protected abstract  com.ibm.wps.util.MessageCode | getMessageCode() Return the message code used to format the exception
 | 
| protected abstract  java.lang.Object[] | getMessageParameters(java.util.Locale aLocale) Return the parameters used for formatting
 | 
| java.lang.String | getTitle(java.util.Locale aLocale) Return the title of this object in the given locale.
 | 
 
 
| Methods inherited from class org.xml.sax.SAXException | 
| getMessage, toString | 
 
| Methods inherited from class java.lang.Throwable | 
| fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace | 
 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
 
EMPTY_PARAMETERS
protected static final java.lang.Object[] EMPTY_PARAMETERS
- the empty set of parameters, can be used for messages without params
 
- Since:
- 8.5
 
MessageCodeSAXException
protected MessageCodeSAXException()
- Initialize the exception
 
MessageCodeSAXException
protected MessageCodeSAXException(java.lang.Throwable aCause)
- Initialize the exception
 
- Parameters:
- aCause - the root cause
 
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
- Overrides:
- getLocales in class LocalizedSAXException
 
- 
- 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
 
- 
 
getMessageCode
protected abstract com.ibm.wps.util.MessageCode getMessageCode()
- Returns the message code used to format the exception
 
- 
- Returns:
- the message code, not null
 
getMessageParameters
protected abstract java.lang.Object[] getMessageParameters(java.util.Locale aLocale)
- Returns the parameters used for formatting
 
- 
- Parameters:
- aLocale - locale used for formatting
- Returns:
- the parameters, not null
 
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
- Overrides:
- getTitle in class LocalizedSAXException
 
- 
- 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.