Package com.compuware.api.topaz.hostconnections

Class HostConnectionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.compuware.api.topaz.TopazAPIRuntimeException

com.compuware.api.topaz.hostconnections.HostConnectionException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HostIOException, HostNotConnectedException, HostNotDefinedException, HostNotReachableException

public class HostConnectionException
extends TopazAPIRuntimeException

HostConnectionException is the superclass for all unchecked exceptions related to host connections.

Since:

1.0.0

Version:

2.0.0

See Also:

IHost, IHostConnection, Serialized Form

Constructor Summary

Constructors

Constructor	Description
HostConnectionException(String message, String localizedMessage, IHost host)	Constructs a new host connection exception with the specified detail messages and host.
HostConnectionException(String message, String localizedMessage, Throwable cause, IHost host)	Constructs a new host connection exception with the specified detail messages, cause, and host.

Method Summary

Modifier and Type	Method	Description
IHost	getHost()	Returns the host that this exception occurred on.

Methods inherited from class com.compuware.api.topaz.TopazAPIRuntimeException

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

HostConnectionException

public HostConnectionException(String message,
                               String localizedMessage,
                               IHost host)

Constructs a new host connection exception with the specified detail messages and host. 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 TopazAPIRuntimeException.getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

host - the host associated with this exception

Since:

1.0.0

HostConnectionException

public HostConnectionException(String message,
                               String localizedMessage,
                               Throwable cause,
                               IHost host)

Constructs a new host connection exception with the specified detail messages, cause, and host.

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 TopazAPIRuntimeException.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.)

host - the host associated with this exception

Since:

1.0.0

Method Detail

getHost

public IHost getHost()

Returns the host that this exception occurred on.

Returns:

the host

Since:

1.0.0