com.att.inno.env

Class APIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.att.inno.env.APIException

All Implemented Interfaces:

Serializable

public class APIException
extends Exception

An Exception with the ability to hold a payload.

This is important, because sometimes, the output of a Framework may be a descriptive object which doesn't inherit from Throwable and thus cannot be attached in "initCause".

Examples may be a SOAP Fault.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
APIException(String string)
APIException(String errorMessage, Throwable t)
APIException(Throwable t)

Method Summary

Modifier and Type	Method and Description
Object	getPayload() Return payload, or null if none was set.
APIException	setPayload(Object payload) Set a specific payload into this Exception, which doesn't necessarily inherit from Throwable.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

APIException

public APIException(Throwable t)

Parameters:

t -

APIException

public APIException(String string)

Parameters:

string -

APIException

public APIException(String errorMessage,
                    Throwable t)

Parameters:

errorMessage -

t -

Method Detail

getPayload

public Object getPayload()

Return payload, or null if none was set. Type is up to the calling System.

Returns:

Object

setPayload

public APIException setPayload(Object payload)

Set a specific payload into this Exception, which doesn't necessarily inherit from Throwable.

Parameters:

payload -

Returns:

APIException