| Package | com.adobe.livecycle.signatures.common |
| Class | public class CommonBaseException |
| Inheritance | CommonBaseException  Exception
|
| Method | Defined by | ||
|---|---|---|---|
|
An empty constructor.
| CommonBaseException | ||
|
CommonBaseException(String errorMsg)
A constructor that takes an exception message identifier value.
| CommonBaseException | ||
|
CommonBaseException(Throwable chainedException)
A constructor that takes in a chained exception The Exception Message is set to the default error string returned by the
getDefaultErrMsg appended with the string returned by getMessage() of the chained exception. | CommonBaseException | ||
|
CommonBaseException(String errorMsg, Throwable chainedException)
Constructor that takes in a Exception Message ID and a chained Exception The Exception Message as generated by the errorMsg parameter (described below) is appended with the string returned by getMessage() of the chained exception.
| CommonBaseException | ||
|
CommonBaseException(String errorMsg, Object[] params)
Constructor that takes an exception message identifer value and an object array.
| CommonBaseException | ||
|
CommonBaseException(String errorMsg, Object[] params, Throwable chainedException)
A constructor that takes a exception message identifier, an object array, and a chained exception.
| CommonBaseException | ||
|
String getMessage()
Returns an error messge.
| CommonBaseException | ||
|
void printStackTrace()
Prints the StackTrace on System.err.
| CommonBaseException | ||
|
void printStackTrace(PrintStream s)
Prints the StackTrace onto the input PrintStream.
| CommonBaseException | ||
|
void printStackTrace(PrintWriter w)
Prints the StackTrace onto the input PrintWriter.
| CommonBaseException | ||
| CommonBaseException | () |
public CommonBaseException()An empty constructor. The exception message is set to the default error string returned by the getDefaultErrMsg.
| CommonBaseException | () |
public CommonBaseException(String errorMsg)A constructor that takes an exception message identifier value.
ParameterserrorMsg — This parameter can either be a plain string or a valid key in the Properties file returned by getProps. If it is a valid key then the string corresponding to its value in the properties file is used as the exception message. Further as this constructor does not take any object parameters the exception Message in the properties file should not contain any object format specifiers like {0} and so on. If it is not a valid key or the properties file is null, this string is treated as the exception message itself, after prepending it with the default String returned by getDefaultErrMsg. |
| CommonBaseException | () |
public CommonBaseException(Throwable chainedException)A constructor that takes in a chained exception The Exception Message is set to the default error string returned by the getDefaultErrMsg appended with the string returned by getMessage() of the chained exception.
chainedException — Any Object of Throwable type. |
| CommonBaseException | () |
public CommonBaseException(String errorMsg, Throwable chainedException)Constructor that takes in a Exception Message ID and a chained Exception The Exception Message as generated by the errorMsg parameter (described below) is appended with the string returned by getMessage() of the chained exception.
ParameterserrorMsg — This parameter can either be a plain string or a valid key in the Properties file returned by getProps. If it is a valid key then the String corresponding to its value in the properties file is used as the Exception Message. Further as this constructor does not take any object parameters the exception Message in the properties file should not contain any object format specifiers like {0} etc. If it is not a valid key or the properties file is null, this string is treated as the Exception Message itself, after prepending it with the default String returned by getDefaultErrMsg. |
|
chainedException — Any throwable object type. |
| CommonBaseException | () |
public CommonBaseException(String errorMsg, Object[] params)Constructor that takes an exception message identifer value and an object array.
ParameterserrorMsg — This parameter can either be a plain string or a valid key in the properties file returned by getProps. If it is a valid key then the string corresponding to its value in the properties file is used as the exception message. Further as this constructor takes in an object[] params the exception message in the properties file is expected to contain some object format specifiers like {0} etc. If this parameter is not a valid key or the properties file is null, this string is treated as the exception message itself, after prepending it with the default String returned by getDefaultErrMsg. |
|
params — An object array that substitutes in place of the format specifiers like {0}, {1} etc in the formatted message as obtained from the properties file corresponding to the errorMsg as the key. If the array contains more objects than the format specifiers in the message the extra ones will be ignored. If the array contains less number of objects then the extra specifiers will be printed as is. |
| CommonBaseException | () |
public CommonBaseException(String errorMsg, Object[] params, Throwable chainedException)A constructor that takes a exception message identifier, an object array, and a chained exception. The Exception Message as generated by the errorMsg parameter (described below) is appended with the string returned by getMessage() of the chained exception.
ParameterserrorMsg — This parameter can either be a plain string or a valid key in the Properties file returned by getProps. If it is a valid key then the String corresponding to its value in the properties file is used as the Exception Message. Further as this constructor takes in an object[] params the exception Message in the properties file is expected to contain some object format specifiers like {0} etc. If this parameter is not a valid key or the properties file is null, this string is treated as the Exception Message itself, after prepending it with the default String returned by getDefaultErrMsg. |
|
params — an array of Objects which will be substituted in place of the format specifiers like {0}, {1} etc in the formatted message as obtained from the properties file corresponding to the errorMsg as the key. If the array contains more objects than the format specifiers in the message the extra ones will be ignored. If the array contains less number of objects then the extra specifiers will be printed as is. |
|
chainedException — Any throwable object type. |
| getMessage | () |
public String getMessage()Returns an error messge.
Returns| printStackTrace | () |
public void printStackTrace()Prints the StackTrace on System.err.
| printStackTrace | () |
public void printStackTrace(PrintStream s)Prints the StackTrace onto the input PrintStream.
Parameters
s |
| printStackTrace | () |
public void printStackTrace(PrintWriter w)Prints the StackTrace onto the input PrintWriter.
Parameters
w |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/signatures/common/CommonBaseException.html