com.sap.exception

Interface IBaseException

All Known Implementing Classes:

BaseException, BaseRuntimeException, MultipartParseException, SAPFileNotFoundException, SAPIllegalAccessException, SAPIllegalArgumentException, SAPIOException, SAPMissingResourceException, SAPNullPointerException, SAPNumberFormatException, SAPRemoteException, SAPUnsupportedOperationException

public interface IBaseException

Common interface for BaseException and BaseRuntimeException. Objects of type IBaseException can optionally hold a reference to another Throwable object (root cause) and a language independent message object of type LocalizableText.

See Also:

LocalizableText, BaseException, BaseRuntimeException

Field Summary

static Category	audit Category for logging traces.
static Locale	defaultLocale Default Locale.

Method Summary

void	finallyLocalize() Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(Locale loc) Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(Locale loc, TimeZone timeZone) Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(TimeZone timeZone) Finally localizes the LocalizableText message (if there is one attached).
Throwable	getCause() Getter method for root cause.
LocalizableText	getLocalizableMessage() Getter method for localizable message.
String	getLocalizedMessage() Gets localized message.
String	getLocalizedMessage(Locale loc) Gets localized message.
String	getLocalizedMessage(Locale loc, TimeZone timeZone) Gets localized message.
String	getLocalizedMessage(TimeZone timeZone) Gets localized message.
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() Chains the stack trace information of nested exceptions.
String	getStackTraceString() Gets stack trace information of this exception only.
String	getSystemStackTraceString() Gets the stack information of this exception in respect of the current system environment.
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 this exception and its backtrace to the standard error stream.
void	printStackTrace(PrintStream s) Prints this exception 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	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.

Field Detail

audit

public static final Category audit

Category for logging traces.

defaultLocale

public static final Locale defaultLocale

Default Locale.

Method Detail

initCause

public Throwable initCause(Throwable cause)

Initializes the cause of this exception to the specified value. (The cause is the throwable that caused this exception to get thrown.)

This method can be called at most once. That means the cause can be specified only once.

Parameters:

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.)

Returns:

a reference to this exception instance.

Throws:

IllegalArgumentException - if cause is this throwable. (A throwable cannot be its own cause.)

IllegalStateException - if the cause was already set

getCause

public Throwable getCause()

Getter method for root cause.

Returns:

throwable object which caused this exception or null

getLocalizableMessage

public LocalizableText getLocalizableMessage()

Getter method for localizable message.

Returns:

localizable message or null

getLocalizedMessage

public String getLocalizedMessage()

Gets localized message.

The default locale and default time zone are used for localization.

These values have no effect if the finallyLocalize method has already been called.

Returns:

message string or null

getLocalizedMessage

public String getLocalizedMessage(Locale loc)

Gets localized message.

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.

Parameters:

loc - locale

Returns:

message string or null

getLocalizedMessage

public String getLocalizedMessage(TimeZone timeZone)

Gets localized message.

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.

Parameters:

timeZone - time zone

Returns:

message string or null

getLocalizedMessage

public String getLocalizedMessage(Locale loc,
                                  TimeZone timeZone)

Gets localized message.

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 are null respectively.

These values have no effect if the finallyLocalize method has been already called.

Parameters:

loc - locale

timeZone - time zone

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage()

Chains localized messages of the nested exceptions.

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.

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale loc)

Chains localized messages of the nested exceptions.

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.

Parameters:

loc - locale

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(TimeZone timeZone)

Chains localized message of the nested exceptions.

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.

If the localized message is not specified, the non-localizable message is returned (if specified).

Parameters:

timeZone - time zone

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale loc,
                                        TimeZone timeZone)

Chains localized message of the nested exceptions.

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.

Parameters:

loc - locale

timeZone - time zone

Returns:

message string

finallyLocalize

public void finallyLocalize()

Finally localizes the LocalizableText message (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.

finallyLocalize

public void finallyLocalize(Locale loc)

Finally localizes the LocalizableText message (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.

Parameters:

loc - locale

finallyLocalize

public void finallyLocalize(TimeZone timeZone)

Finally localizes the LocalizableText message (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 time zone parameter is null, the default time zone will be used.

Parameters:

timeZone - time zone

finallyLocalize

public void finallyLocalize(Locale loc,
                            TimeZone timeZone)

Finally localizes the LocalizableText message (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.

Parameters:

loc - locale

timeZone - time zone

getSystemStackTraceString

public String getSystemStackTraceString()

Gets the stack information of this exception in respect of the current system environment.

Returns:

the stack trace as a string in respect of the current system

getStackTraceString

public String getStackTraceString()

Gets stack trace information of this exception only.

The stack traces of nested exceptions are not chained.

Returns:

the stack trace as a string without information of chained exceptions.

getNestedStackTraceString

public String getNestedStackTraceString()

Chains the stack trace information of nested exceptions.

The caused stack trace is displayed first.

Returns:

the stack trace as a string

printStackTrace

public void printStackTrace()

Prints this exception and its backtrace to the standard error stream. This method prints a stack trace for this exception object on the error output stream that is the value of the field System.err.

printStackTrace

public void printStackTrace(PrintStream s)

Prints this exception and its backtrace to the specified print stream.

Parameters:

s - PrintStream to use for output

printStackTrace

public void printStackTrace(PrintWriter s)

Prints the action object and its backtrace to the specified print writer.

Parameters:

s - PrintWriter to use for output

setLogSettings

public 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.

Setter method for logging information.

Parameters:

cat - logging category

severity - logging severity

loc - logging location

log

public void log()

Deprecated. Instead of this method it should be used some suitable method from Logging API. The method is left for backward compatibility.

Logs the exception message. The logging takes only place if the category and location are set properly.

See Also:

setLogSettings(Category, int, Location)