|
SAP NetWeaver '04 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sap.exception.BaseExceptionInfo
This class encapsulates the work necessary for implementing
the IBaseException interface. It can be viewed as a
helper class for exception classes implementing the
IBaseException interface directly without inheriting
from BaseException or BaseRuntimeException.
IBaseException,
BaseException,
BaseRuntimeException,
Serialized Form| Constructor Summary | |
BaseExceptionInfo(Category cat,
int severity,
Location loc,
LocalizableText locMessage,
Throwable action,
Throwable cause)
Deprecated. Category and severity must not be used inside of Exception API. The method is left for backward compatibility. |
|
BaseExceptionInfo(Category cat,
int severity,
Location loc,
ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action,
Throwable rootCause)
Deprecated. Category and severity must not be used inside of Exception API. The method is left for backward compatibility. |
|
BaseExceptionInfo(LocalizableText locMessage,
Throwable action)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(LocalizableText locMessage,
Throwable action,
Throwable cause)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(Location loc,
LocalizableText locMessage,
Throwable action)
Constructor for specifying a localizable message and the action cause. |
|
BaseExceptionInfo(Location loc,
LocalizableText locMessage,
Throwable action,
Throwable cause)
Constructor for specifying a localizable message, the action cause and the root cause. |
|
BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
LocalizableText.Msg msg,
Throwable action,
Throwable cause)
Constructor for specifying a localizable message, the action cause and the root cause. |
|
BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action)
Constructor for specifying a localizable message and the action cause. |
|
BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action,
Throwable rootCause)
Constructor for specifying a localizable message, the action cause and the root cause. |
|
BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Throwable action)
Constructor for specifying a localizable message and the action cause. |
|
BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Throwable action,
Throwable rootCause)
Constructor for specifying a localizable message, the action cause and the root cause. |
|
BaseExceptionInfo(Location loc,
Throwable action)
Simple constructor specifying the action cause. |
|
BaseExceptionInfo(Location loc,
Throwable action,
Throwable cause)
Constructor for specifying the action and root cause. |
|
BaseExceptionInfo(ResourceAccessor accessor,
LocalizableText.Msg msg,
Throwable action,
Throwable cause)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action,
Throwable rootCause)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Throwable action)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Throwable action,
Throwable rootCause)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(Throwable action)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
BaseExceptionInfo(Throwable action,
Throwable cause)
Deprecated. Every constructor must have an location as input parameter to make possible automatic exception tracing. The method is left for backward compatibility. |
|
| Method Summary | |
void |
finallyLocalize()
Finally localizes the LocalizableText message
of the action throwable (if there is one attached).
|
void |
finallyLocalize(Locale loc)
Finally localizes the LocalizableText message
of the action throwable (if there is one attached).
|
void |
finallyLocalize(Locale loc,
TimeZone timeZone)
Finally localizes the LocalizableText message
of the action throwable (if there is one attached).
|
void |
finallyLocalize(TimeZone timeZone)
Finally localizes the LocalizableText message
of the action throwable.
|
Throwable |
getCause()
Getter method for root cause. |
LocalizableText |
getLocalizableMessage()
Getter method for localizable message. |
String |
getLocalizedMessage()
Gets localized action message. |
String |
getLocalizedMessage(Locale loc)
Gets localized action message. |
String |
getLocalizedMessage(Locale loc,
TimeZone timeZone)
Gets localized action message. |
String |
getLocalizedMessage(TimeZone timeZone)
Gets localized action message. |
Category |
getLogCategory()
Getter method for logging category. |
Location |
getLogLocation()
Getter method for logging location. |
int |
getLogSeverity()
Getter method for logging severity. |
String |
getNestedLocalizedMessage()
Chains localized messages of the nested exceptions. |
String |
getNestedLocalizedMessage(Locale loc)
Chains localized messages of the nested exceptions. |
String |
getNestedLocalizedMessage(Locale loc,
TimeZone timeZone)
Chains localized message of the nested exceptions. |
String |
getNestedLocalizedMessage(TimeZone timeZone)
Chains localized message of the nested exceptions. |
String |
getNestedStackTraceString()
Get stack trace information as a string. |
String |
getStackTraceString()
Gets stack trace information of this exception. |
Throwable |
initCause(Throwable cause)
Initializes the cause of this exception to the specified value. |
void |
log()
Deprecated. Instead of this method it should be used some suitable method from Logging API. The method is left for backward compatibility. |
void |
printStackTrace()
Prints the action exception and its backtrace to the
standard error stream. |
void |
printStackTrace(PrintStream s)
Prints the action object and its backtrace to the
specified print stream. |
void |
printStackTrace(PrintWriter s)
Prints the action object and its backtrace
to the specified print writer. |
void |
restoreLogSettings()
Restores log settings to their original value before method setLogSettings(Category, int, Location) has been used. |
void |
setLogSettings(Category cat,
int severity,
Location loc)
Deprecated. Category and severity must not be used inside of Exception API. The method is left for backward compatibility. |
void |
trace(int severity,
Location loc)
Stores the stack trace of the action in the
specified location.
|
void |
trace(int severity,
Location loc,
String subloc)
Stores the stack trace of the action in the
specified location.
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public BaseExceptionInfo(Throwable action)
action - the caused throwable
IllegalArgumentException - if action is null
public BaseExceptionInfo(Location loc,
Throwable action)
loc - logging location which will be used in case of automatic tracingaction - the caused throwable
IllegalArgumentException - if action is null
public BaseExceptionInfo(Throwable action,
Throwable cause)
action - the caused throwablecause - the root cause
IllegalArgumentException - if action is null or
cause is equal to
action (A throwable cannot be its own cause.)
public BaseExceptionInfo(Location loc,
Throwable action,
Throwable cause)
loc - logging location which will be used in case of automatic tracingaction - the caused throwablecause - the root cause
IllegalArgumentException - if action is null or
cause is equal to
action (A throwable cannot be its own cause.)
public BaseExceptionInfo(LocalizableText locMessage,
Throwable action)
locMessage - localizable messageaction - the caused throwable
IllegalArgumentException - if action is null
public BaseExceptionInfo(Location loc,
LocalizableText locMessage,
Throwable action)
loc - logging location which will be used in case of automatic tracinglocMessage - localizable messageaction - the caused throwable
IllegalArgumentException - if action is null
public BaseExceptionInfo(LocalizableText locMessage,
Throwable action,
Throwable cause)
locMessage - localizable messageaction - the caused throwablecause - the root cause
IllegalArgumentException - if action is null or
cause is equal to
action (A throwable cannot be its own cause.)
public BaseExceptionInfo(Location loc,
LocalizableText locMessage,
Throwable action,
Throwable cause)
loc - logging location which will be used in case of automatic tracinglocMessage - localizable messageaction - the caused throwablecause - the root cause
IllegalArgumentException - if action is null or
cause is equal to
action (A throwable cannot be its own cause.)
public BaseExceptionInfo(Category cat,
int severity,
Location loc,
LocalizableText locMessage,
Throwable action,
Throwable cause)
cat - logging categoryseverity - logging severityloc - logging locationlocMessage - localizable messageaction - the caused throwablecause - the root cause
IllegalArgumentException - if action is null or
cause is equal to
action (A throwable cannot be its own cause.)
public BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Throwable action)
accessor - resource accessorpatternKey - pattern keyaction - the caused throwable
IllegalArgumentException - if action is null or
cause is equal to
action (A throwable cannot be its own cause.)
public BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Throwable action)
loc - logging location which will be used in case of automatic tracingaccessor - resource accessorpatternKey - pattern keyaction - the caused throwable
IllegalArgumentException - if action is null or
cause is equal to
action (A throwable cannot be its own cause.)
public BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Throwable action,
Throwable rootCause)
accessor - resource accessorpatternKey - pattern key for text messageaction - the caused throwablerootCause - throwable object, which caused this exception
public BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Throwable action,
Throwable rootCause)
loc - logging location which will be used in case of automatic tracingaccessor - resource accessorpatternKey - pattern key for text messageaction - the caused throwablerootCause - throwable object, which caused this exception
public BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action)
accessor - resource accessorpatternKey - pattern key for text messageparameters - message parametersaction - the caused throwable
public BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action)
loc - logging location which will be used in case of automatic tracingaccessor - resource accessorpatternKey - pattern key for text messageparameters - message parametersaction - the caused throwable
public BaseExceptionInfo(ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action,
Throwable rootCause)
accessor - resource accessorpatternKey - pattern key for text messageparameters - message parametersrootCause - throwable object, which caused this exception
public BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action,
Throwable rootCause)
loc - logging location which will be used in case of automatic tracingaccessor - resource accessorpatternKey - pattern key for text messageparameters - message parametersaction - the caused throwablerootCause - throwable object, which caused this exception
public BaseExceptionInfo(Category cat,
int severity,
Location loc,
ResourceAccessor accessor,
String patternKey,
Object[] parameters,
Throwable action,
Throwable rootCause)
cat - logging categoryseverity - logging severityloc - logging locationaccessor - patternKey - parameters - action - rootCause - throwable object, which caused this exception
public BaseExceptionInfo(ResourceAccessor accessor,
LocalizableText.Msg msg,
Throwable action,
Throwable cause)
accessor - the resource accessormsg - message containing pattern key and argumentsaction - the caused throwablecause - throwable object, which caused this exception
public BaseExceptionInfo(Location loc,
ResourceAccessor accessor,
LocalizableText.Msg msg,
Throwable action,
Throwable cause)
loc - logging location which will be used in case of automatic tracingaccessor - the resource accessormsg - message containing pattern key and argumentsaction - the caused throwablecause - throwable object, which caused this exception| Method Detail |
public Throwable initCause(Throwable cause)
This method can be called at most once. That means the cause can be specified only once.
cause - the cause (which is saved for later retrieval by the
getCause() method). (A null value is
permitted, and indicates that the cause is nonexistent or
unknown.)
IllegalArgumentException - if cause is this
throwable. (A throwable cannot be its own cause.)
IllegalStateException - if the cause was already setpublic void printStackTrace()
action exception and its backtrace to the
standard error stream. This method prints a stack trace for the
actionexception object on the error output stream that is
the value of the field System.err.
public void printStackTrace(PrintStream s)
action object and its backtrace to the
specified print stream.
s - PrintStream to use for outputpublic void printStackTrace(PrintWriter s)
action object and its backtrace
to the specified print writer.
s - PrintWriter to use for outputpublic String getStackTraceString()
public String getNestedStackTraceString()
public Throwable getCause()
public LocalizableText getLocalizableMessage()
public void finallyLocalize()
LocalizableText message
of the action throwable (if there is one attached).
That means no further localization process can be performed
on that object. If there is a nested exception implementing
IBaseException, it will be localized recursively.
The default locale and the default time zone are used for localization.
public void finallyLocalize(Locale loc)
LocalizableText message
of the action throwable (if there is one attached).
That means no further localization process can be performed
on that object. If there is a nested exception implementing
IBaseException, it will be localized recursively.
The specified locale and the default time zone are used for localization. If the locale parameter is null, the default locale will be used.
loc - localepublic void finallyLocalize(TimeZone timeZone)
LocalizableText message
of the action throwable.
(if there is one attached).
That means no further localization process can be performed
on that object. If there is a nested exception implementing
IBaseException, it will be localized recursively.
The specified time zone and the default locale are used for localization. If the time zone parameter is null, the default time zone will be used.
timeZone - time zone
public void finallyLocalize(Locale loc,
TimeZone timeZone)
LocalizableText message
of the action throwable (if there is one attached).
That means no further localization process can be performed
on that object.If there is a nested exception implementing
IBaseException, it will be localized recursively.
The specified locale and the specified time zone are used for localization. If the time zone parameter or the locale parameter are null, the default values will be used respectively.
loc - localetimeZone - time zonepublic String getLocalizedMessage()
The default locale and default time zone are used for localization. These values have no effect if the finallyLocalize method has already been called.
public String getLocalizedMessage(Locale loc)
The specified locale and the default time zone are used for localization. The default locale will be used if the Locale parameter is null.
These values have no effect if the finallyLocalize method has been already called.
loc - locale
public String getLocalizedMessage(TimeZone timeZone)
The specified time zone and the default locale are used for localization. The default time zone will be used, if the time zone parameter is null.
These values have no effect if the finallyLocalize method has been already called.
timeZone - time zone
public String getLocalizedMessage(Locale loc,
TimeZone timeZone)
The specified time zone and locale are used for localization. The default time zone and the default locale will be used, if the time zone parameter and the locale are null respectively.
These values have no effect if the finallyLocalize method has been already called.
loc - localetimeZone - time zone
public String getNestedLocalizedMessage()
The default locale and the default time zone are used for localization.
These values have no effect if the finallyLocalize method has already been called.
public String getNestedLocalizedMessage(Locale loc)
The specified locale and the default time zone are used for localization. The default locale will be used if the Locale parameter is null.
These values have no effect if the finallyLocalize method has been already called.
loc - locale
public String getNestedLocalizedMessage(TimeZone timeZone)
The specified time zone and the default locale are used for localization. The default time zone will be used, if the time zone parameter is null.
These values have no effect if the finallyLocalize method has been already called.
timeZone - time zone
public String getNestedLocalizedMessage(Locale loc,
TimeZone timeZone)
The specified time zone and locale are used for localization. The default time zone and the default locale will be used, if the time zone parameter or the locale parameter are null respectively.
These values have no effect if the finallyLocalize method has been already called.
loc - localetimeZone - time zone
public Category getLogCategory()
If no category is specified, null is returned.
public int getLogSeverity()
If no severity is specified,
Severity.NONE is returned.
public Location getLogLocation()
If no location is specified, null is returned.
public void setLogSettings(Category cat,
int severity,
Location loc)
cat - logging categoryseverity - logging severityloc - logging locationpublic void log()
action
throwable.
public void trace(int severity,
Location loc)
action in the
specified location.
The used category is defined by the
action's IBaseException.audit property.
severity - severity of messageloc - location message stems from
public void trace(int severity,
Location loc,
String subloc)
action in the
specified location.
The used category is defined by the
action's IBaseException.audit property.
severity - severity of messageloc - location message stems fromsubloc - name of sublocationpublic void restoreLogSettings()
setLogSettings(Category, int, Location)
|
SAP NetWeaver '04 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||