com.filenet.download.api.exception

Class ClientDownloadRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.filenet.download.api.exception.ClientDownloadRuntimeException

All Implemented Interfaces:

java.io.Serializable

public class ClientDownloadRuntimeException
extends java.lang.RuntimeException

Used for all unchecked exceptions. The exceptions are defined as ClientDownloadExceptionCode objects. ClientDownloadRuntimeException supports exception chaining (constructing a chain of exceptions by wrapping additional exceptions).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientDownloadRuntimeException()
ClientDownloadRuntimeException(ClientDownloadExceptionCode code) Use this to specify only the ClientDownloadExceptionCode object for this exception.
ClientDownloadRuntimeException(ClientDownloadExceptionCode code, java.lang.Object codeArg0) Use this to specify the ClientDownloadExceptionCode object and the specific value in use (code argument) when the error occurred for this exception.
ClientDownloadRuntimeException(ClientDownloadExceptionCode code, java.lang.Object[] codeArgs) Use this to specify the ClientDownloadExceptionCode object and an array of specific values (code arguments) in use when the error occurred for this exception.
ClientDownloadRuntimeException(java.lang.Throwable cause, ClientDownloadExceptionCode code, java.lang.Object[] codeArgs) Use this for exception chaining.

Method Summary

Modifier and Type	Method and Description
ClientDownloadExceptionCode	getExceptionCode() Gets the ClientDownloadExceptionCode object specified for this instance.
java.lang.String	getLocalizedMessage() Gets a localized version of the description string (using the default locale) specified in the ClientDownloadExceptionCode object used for this instance.
java.lang.String	getMessage() Gets a localized version of the description string (using the default locale) specified in the ClientDownloadExceptionCode object used for this instance.
java.lang.String	toString() Returns a description of this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientDownloadRuntimeException

public ClientDownloadRuntimeException()

ClientDownloadRuntimeException

public ClientDownloadRuntimeException(ClientDownloadExceptionCode code,
                                      java.lang.Object[] codeArgs)

Use this to specify the ClientDownloadExceptionCode object and an array of specific values (code arguments) in use when the error occurred for this exception.

Parameters:

code - The ClientDownloadExceptionCode object to use.

codeArgs - An Object array containing the code arguments. This can be null.

ClientDownloadRuntimeException

public ClientDownloadRuntimeException(ClientDownloadExceptionCode code)

Use this to specify only the ClientDownloadExceptionCode object for this exception.

Parameters:

code - The ClientDownloadExceptionCode object to use.

ClientDownloadRuntimeException

public ClientDownloadRuntimeException(ClientDownloadExceptionCode code,
                                      java.lang.Object codeArg0)

Use this to specify the ClientDownloadExceptionCode object and the specific value in use (code argument) when the error occurred for this exception.

Parameters:

code - The ClientDownloadExceptionCode object to use.

codeArg0 - An Object containing the code argument. This can be null.

ClientDownloadRuntimeException

public ClientDownloadRuntimeException(java.lang.Throwable cause,
                                      ClientDownloadExceptionCode code,
                                      java.lang.Object[] codeArgs)

Use this for exception chaining. Include the ClientDownloadExceptionCode object and an array of specific values (code arguments) in use when the error occurred for this (wrapping) exception. The Throwable object specified is wrapped (nested) within this exception.

Parameters:

cause - A java.lang.Throwable object containing the exception to wrap.

code - The ClientDownloadExceptionCode object to use.

codeArgs - An Object array containing the code arguments. This can be null.

Method Detail

getMessage

public java.lang.String getMessage()

Gets a localized version of the description string (using the default locale) specified in the ClientDownloadExceptionCode object used for this instance. This method overrides java.lang.Throwable.getMessage.

Overrides:

getMessage in class java.lang.Throwable

Returns:

A String containing the localized exception description.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Gets a localized version of the description string (using the default locale) specified in the ClientDownloadExceptionCode object used for this instance. This method overrides java.lang.Throwable.getLocalizedMessage.

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

A String containing the localized exception description.

getExceptionCode

public ClientDownloadExceptionCode getExceptionCode()

Gets the ClientDownloadExceptionCode object specified for this instance.

Returns:

The ClientDownloadExceptionCode object for this exception.

toString

public java.lang.String toString()

Returns a description of this exception. The result is the concatenation of the following:

• The name of this exception's class
• The name of the exception code
• The localized error message
• The exception's error stack

Overrides:

toString in class java.lang.Throwable

Returns:

A String representation of this exception.