Package com.compuware.api.topaz.hostresources

Class HostResourceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.compuware.api.topaz.TopazAPIException

com.compuware.api.topaz.hostresources.HostResourceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AllocationFailedException, DataSetAccessException, DataSetExistsException, DataSetInUseException, DataSetMigratedException, DataSetNotFoundException, DataSetOutOfSpaceException, DefinitionFailedException, GenerationDataGroupExistsException, GenerationDataGroupNotFoundException, MemberAlreadyExistsException, MemberInUseException, MemberNotFoundException

public class HostResourceException
extends TopazAPIException

HostResourceException is the superclass for all checked exceptions related to host resources.

Since:

1.0.0

Version:

2.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HostResourceException(String message, String localizedMessage, String hostResourceName)	Constructs a new host resource exception with the specified detail messages and resource name.
HostResourceException(String message, String localizedMessage, Throwable cause, String hostResourceName)	Constructs a new host resource exception with the specified detail messages, cause, and resource name.

Method Summary

Modifier and Type	Method	Description
String	getHostResourceName()	Returns the name of the host resource associated with this exception.

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

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

HostResourceException

public HostResourceException(String message,
                             String localizedMessage,
                             String hostResourceName)

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

hostResourceName - the name of the host resource associated with this exception

Since:

1.0.0

HostResourceException

public HostResourceException(String message,
                             String localizedMessage,
                             Throwable cause,
                             String hostResourceName)

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

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

hostResourceName - the name of the host resource associated with this exception

Since:

1.0.0

Method Detail

getHostResourceName

public String getHostResourceName()

Returns the name of the host resource associated with this exception.

Returns:

the host resource name

Since:

1.0.0