Overview | Package | Class | Tree | Deprecated | Index | Help
| J2EE1.4 SDK
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.xml.registry
Class JAXRException

    java.lang.Object
      java.lang.Throwable
          java.lang.Exception
              javax.xml.registry.JAXRException

All Implemented Interfaces:
  JAXRResponse, java.io.Serializable

Direct Known Subclasses:
  InvalidRequestException, RegistryException, UnexpectedObjectException, UnsupportedCapabilityException

public class JAXRException
extends java.lang.Exception
implements JAXRResponse

Signals that a JAXR exception has occurred. It contains no members other than the standard reason String.

Author:
  Nicholas Kassem, Mark Hapner, Rajiv Mordani, Farrukh Najmi
See Also:
  `JAXRResponse`, Serialized Form

Field Summary
`protected java.lang.Throwable` | `cause`

Fields inherited from interface javax.xml.registry.JAXRResponse
`STATUS_FAILURE, STATUS_SUCCESS, STATUS_UNAVAILABLE, STATUS_WARNING`

Constructor Summary
`JAXRException()` Constructs a `JAXRException` object with no reason or embedded Throwable.
`JAXRException(java.lang.String reason)` Constructs a `JAXRException` object with the given `String` as the reason for the exception being thrown.
`JAXRException(java.lang.String reason, java.lang.Throwable cause)` Constructs a `JAXRException` object with the given `String` as the reason for the exception being thrown and the given `Throwable` object as an embedded Throwable.
`JAXRException(java.lang.Throwable cause)` Constructs a `JAXRException` object initialized with the given `Throwable` object.

Method Summary
`java.lang.Throwable` | `getCause()` Returns the Throwable embedded in this `JAXRException` if there is one.
`java.lang.String` | `getMessage()` Returns the detail message for this `JAXRException` object.
`java.lang.String` | `getRequestId()` Returns the unique id for the request that generated this response.
`int` | `getStatus()` Returns the status for this response.
`java.lang.Throwable` | `initCause(java.lang.Throwable cause)` Initializes the cause of this throwable to the specified value.
`boolean` | `isAvailable()` Returns true if a response is available, false otherwise.

Methods inherited from class java.lang.Throwable
`fillInStackTrace, getLocalizedMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### cause

    protected java.lang.Throwable cause

Constructor Detail

### JAXRException

    public JAXRException()

  Constructs a `JAXRException` object with no reason or embedded Throwable.

### JAXRException

    public JAXRException(java.lang.String reason)

  Constructs a `JAXRException` object with the given `String` as the reason for the exception being thrown.

Parameters:
  `reason` - a description of what caused the exception

### JAXRException

    public JAXRException(java.lang.String reason,
                         java.lang.Throwable cause)

  Constructs a `JAXRException` object with the given `String` as the reason for the exception being thrown and the given `Throwable` object as an embedded Throwable.

Parameters:
  `reason` - a description of what caused the exception
  `cause` - a `Throwable` object that is to be embedded in this `JAXRException` object

### JAXRException

    public JAXRException(java.lang.Throwable cause)

  Constructs a `JAXRException` object initialized with the given `Throwable` object.

Parameters:
  `cause` - the Throwable that caused this Exception

Method Detail

### getMessage

    public java.lang.String getMessage()

  Returns the detail message for this `JAXRException` object.

  If there is an embedded Throwable, and if the `JAXRException` object has no detail message of its own, this method will return the detail message from the embedded Throwable.

  Returns:
    the error or warning message for this `JAXRException` or, if it has none, the message of the embedded Throwable, if there is one

### getCause

    public java.lang.Throwable getCause()

  Returns the Throwable embedded in this `JAXRException` if there is one. Otherwise, this method returns `null`.

  Returns:
    the embedded Throwable or `null` if there is none

### initCause

    public java.lang.Throwable initCause(java.lang.Throwable cause)

  Initializes the cause of this throwable to the specified value. (The cause is the throwable that caused this throwable to get thrown.)

  This method can be called at most once. It is generally called from within the constructor, or immediately after creating the throwable. If this throwable was created with `JAXRException(Throwable)` or `JAXRException(String,Throwable)`, this method cannot be called even once.

  Parameters:
    `cause` - the cause (which is saved for later retrieval by the `getCause()` method). (A `null` value is permitted, and indicates that the cause is nonexistent or unknown.)
  Returns:
    a reference to this `Throwable` instance.
  Throws:
    `java.lang.IllegalArgumentException` - if `cause` is this throwable. (A throwable cannot be its own cause.)
    `java.lang.IllegalStateException` - if this throwable was created with `JAXRException(Throwable)` or `JAXRException(String,Throwable)`, or this method has already been called on this throwable.

### getRequestId

    public java.lang.String getRequestId()

  Description copied from interface: `JAXRResponse`
  Returns the unique id for the request that generated this response.

  Capability Level: 0

  Specified by:
    `getRequestId` in interface `JAXRResponse`
  Returns:
    the request id

### getStatus

    public int getStatus()

  Description copied from interface: `JAXRResponse`
  Returns the status for this response.

  Capability Level: 0

  Specified by:
    `getStatus` in interface `JAXRResponse`
  Returns:
    the status which is an integer enumerated value
  See Also:
    `JAXRResponse.STATUS_SUCCESS`

### isAvailable

    public boolean isAvailable()
                        throws JAXRException

  Returns true if a response is available, false otherwise. This is a polling method and must not block.

  Specified by:
    `isAvailable` in interface `JAXRResponse`
  Returns:
    `true` if the response is available; `false` otherwise
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

Overview | Package | Class | Tree | Deprecated | Index | Help
| J2EE1.4 SDK
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature

Copyright 2003 Sun Microsystems, Inc. All rights reserved.