|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.Throwable java.lang.Exception com.adobe.livecycle.encryption.client.CommonBaseException
public class CommonBaseException
Represents an exception that is thrown by the Encryption service.
Constructor Summary | |
---|---|
CommonBaseException(java.lang.String errorMsg)
A constructor that takes an exception message identifier value. |
|
CommonBaseException(java.lang.String errorMsg,
java.lang.Object[] params)
Constructor that takes an exception message identifer value and an object array. |
|
CommonBaseException(java.lang.String errorMsg,
java.lang.Object[] params,
java.lang.Throwable chainedException)
A constructor that takes a exception message identifier, an object array, and a chained exception. |
|
CommonBaseException(java.lang.String errorMsg,
java.lang.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(java.lang.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. |
Method Summary | |
---|---|
java.lang.String |
getErrId()
|
java.lang.String |
getMessage()
Returns an error messge. |
void |
printStackTrace()
Prints the StackTrace on System.err. |
void |
printStackTrace(java.io.PrintStream s)
Prints the StackTrace onto the input PrintStream. |
void |
printStackTrace(java.io.PrintWriter w)
Prints the StackTrace onto the input PrintWriter. |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CommonBaseException(java.lang.String errorMsg)
errorMsg
- This parameter can either be a plain string or a valid key in
the Properties file returned by props
.
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
.public CommonBaseException(java.lang.Throwable chainedException)
getDefaultErrMsg
appended with the string
returned by getMessage() of the chained exception.
chainedException
- Any Object of Throwable type.public CommonBaseException(java.lang.String errorMsg, java.lang.Throwable chainedException)
errorMsg
- This parameter can either be a plain string or a valid key in
the Properties file returned by props
.
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.public CommonBaseException(java.lang.String errorMsg, java.lang.Object[] params)
errorMsg
- This parameter can either be a plain string or a valid key in
the properties file returned by props
.
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.public CommonBaseException(java.lang.String errorMsg, java.lang.Object[] params, java.lang.Throwable chainedException)
errorMsg
- This parameter can either be a plain string or a valid key in
the Properties file returned by props
.
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.Method Detail |
---|
public java.lang.String getMessage()
getMessage
in class java.lang.Throwable
public void printStackTrace()
printStackTrace
in class java.lang.Throwable
public void printStackTrace(java.io.PrintStream s)
printStackTrace
in class java.lang.Throwable
public void printStackTrace(java.io.PrintWriter w)
printStackTrace
in class java.lang.Throwable
public java.lang.String getErrId()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |