Java EE 5 SDK

javax.resource
Class ResourceException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by javax.resource.ResourceException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ApplicationServerInternalException, CommException, EISSystemException, IllegalStateException, InvalidPropertyException, LocalTransactionException, NotSupportedException, ResourceAdapterInternalException, ResourceAllocationException, ResourceWarning, SecurityException, SharingViolationException, UnavailableException, WorkException

public class ResourceException
extends Exception

This is the root interface of the exception hierarchy defined for the Connector architecture. The ResourceException provides the following information:

Version:
1.0
Author:
Rahul Sharma, Ram Jeyaraman
See Also:
Serialized Form

Constructor Summary
ResourceException()
          Constructs a new instance with null as its detail message.
ResourceException(String message)
          Constructs a new instance with the specified detail message.
ResourceException(String message, String errorCode)
          Create a new throwable with the specified message and error code.
ResourceException(String message, Throwable cause)
          Constructs a new throwable with the specified detail message and cause.
ResourceException(Throwable cause)
          Constructs a new throwable with the specified cause.
 
Method Summary
 String getErrorCode()
          Get the error code.
 Exception getLinkedException()
          Deprecated. J2SE release 1.4 supports a chained exception facility that allows any throwable to know about another throwable, if any, that caused it to get thrown. Refer to getCause and initCause methods of the java.lang.Throwable class..
 String getMessage()
          Returns a detailed message string describing this exception.
 void setErrorCode(String errorCode)
          Set the error code.
 void setLinkedException(Exception ex)
          Deprecated. J2SE release 1.4 supports a chained exception facility that allows any throwable to know about another throwable, if any, that caused it to get thrown. Refer to getCause and initCause methods of the java.lang.Throwable class.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, 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

ResourceException

public ResourceException()
Constructs a new instance with null as its detail message.


ResourceException

public ResourceException(String message)
Constructs a new instance with the specified detail message.

Parameters:
message - the detail message.

ResourceException

public ResourceException(Throwable cause)
Constructs a new throwable with the specified cause.

Parameters:
cause - a chained exception of type Throwable.

ResourceException

public ResourceException(String message,
                         Throwable cause)
Constructs a new throwable with the specified detail message and cause.

Parameters:
message - the detail message.
cause - a chained exception of type Throwable.

ResourceException

public ResourceException(String message,
                         String errorCode)
Create a new throwable with the specified message and error code.

Parameters:
message - a description of the exception.
errorCode - a string specifying the vendor specific error code.
Method Detail

setErrorCode

public void setErrorCode(String errorCode)
Set the error code.

Parameters:
errorCode - the error code.

getErrorCode

public String getErrorCode()
Get the error code.

Returns:
the error code.

getLinkedException

public Exception getLinkedException()
Deprecated. J2SE release 1.4 supports a chained exception facility that allows any throwable to know about another throwable, if any, that caused it to get thrown. Refer to getCause and initCause methods of the java.lang.Throwable class..

Get the exception linked to this ResourceException

Returns:
linked Exception, null if none

setLinkedException

public void setLinkedException(Exception ex)
Deprecated. J2SE release 1.4 supports a chained exception facility that allows any throwable to know about another throwable, if any, that caused it to get thrown. Refer to getCause and initCause methods of the java.lang.Throwable class.

Add a linked Exception to this ResourceException.

Parameters:
ex - linked Exception

getMessage

public String getMessage()
Returns a detailed message string describing this exception.

Overrides:
getMessage in class Throwable
Returns:
a detailed message string.

Java EE 5 SDK

Submit a bug or feature

Copyright 2006 Sun Microsystems, Inc. All rights reserved.