Package com.compuware.api.topaz

Class TopazAPIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.compuware.api.topaz.TopazAPIException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HostCredentialsException, HostResourceException

public class TopazAPIException
extends Exception

TopazAPIException is the superclass for all Topaz API checked exceptions.

Since:

1.0.0

Version:

2.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TopazAPIException(String message, String localizedMessage)	Constructs a new Topaz API exception with the specified detail messages.
TopazAPIException(String message, String localizedMessage, Throwable cause)	Constructs a new Topaz API exception with the specified detail messages and cause.

Method Summary

Modifier and Type	Method	Description
String	getLocalizedMessage()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TopazAPIException

public TopazAPIException(String message,
                         String localizedMessage)

Constructs a new Topaz API exception with the specified detail messages. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

Since:

1.0.0

TopazAPIException

public TopazAPIException(String message,
                         String localizedMessage,
                         Throwable cause)

Constructs a new Topaz API exception with the specified detail messages and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

1.0.0

Method Detail

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable