org.osgi.service.transaction.control

Class ScopedWorkException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgi.service.transaction.control.ScopedWorkException

All Implemented Interfaces:

Serializable

public class ScopedWorkException
extends RuntimeException

An Exception that is thrown when a piece of scoped work exits with an Exception

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScopedWorkException(String message, Throwable cause, TransactionContext context) Creates a new TransactionException with the supplied message and cause

Method Summary

Modifier and Type	Method and Description
<T extends Throwable> T	as(Class<T> throwable) Throws the cause of this Exception as a RuntimeException, or as the supplied Exception type.
<A extends Throwable,B extends Throwable> RuntimeException	asOneOf(Class<A> a, Class<B> b) Throws the cause of this Exception as a RuntimeException, or as one of the supplied Exception types.
<A extends Throwable,B extends Throwable,C extends Throwable> RuntimeException	asOneOf(Class<A> a, Class<B> b, Class<C> c) Throws the cause of this Exception as a RuntimeException or one of the supplied Exception types.
<A extends Throwable,B extends Throwable,C extends Throwable,D extends Throwable> RuntimeException	asOneOf(Class<A> a, Class<B> b, Class<C> c, Class<D> d) Throws the cause of this Exception as a RuntimeException or one of the supplied Exception types.
RuntimeException	asRuntimeException()
TransactionContext	ongoingContext()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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

ScopedWorkException

public ScopedWorkException(String message,
                           Throwable cause,
                           TransactionContext context)

Creates a new TransactionException with the supplied message and cause

Parameters:

message -

cause -

context -

Method Detail

ongoingContext

public TransactionContext ongoingContext()

Returns:

The ongoing transaction context if the current scope was still active when this exception was raised or null otherwise. Note that this property will not be persisted during serialization.

asRuntimeException

public RuntimeException asRuntimeException()

Returns:

The cause of this Exception as a RuntimeException if it is one, or this otherwise

as

public <T extends Throwable> T as(Class<T> throwable)
                           throws T extends Throwable,
                                  IllegalArgumentException

Throws the cause of this Exception as a RuntimeException, or as the supplied Exception type.

Usage is of the form:

 public void doStuff() throws IOException {
     try {
         ...
     } catch (ScopedWorkException swe) {
         throw swe.as(IOException.class);
     }
 }
 

Parameters:

throwable - The exception type to throw

Returns:

This method will always throw an exception, either:

• The cause of this exception as the type <T>
• The cause of this exception as a runtime exception
• An IllegalArgumentException with its cause set to this

Throws:

T - the type of exception to be thrown

IllegalArgumentException - if the cause is not a RuntimeException or of type T

T extends Throwable

asOneOf

public <A extends Throwable,B extends Throwable> RuntimeException asOneOf(Class<A> a,
                                                                          Class<B> b)
                                                                   throws A extends Throwable,
                                                                          B extends Throwable,
                                                                          IllegalArgumentException

Throws the cause of this Exception as a RuntimeException, or as one of the supplied Exception types.

Usage is of the form:

 public void doStuff() throws IOException, ClassNotFoundException {
     try {
         ...
     } catch (ScopedWorkException swe) {
         throw swe.asOneOf(IOException.class, ClassNotFoundException.class);
     }
 }
 

Parameters:

a - The first possible exception type to throw

b - The second possible exception type to throw

Returns:

This method will always throw an exception, either:

• The cause of this exception as the type <A>
• The cause of this exception as the type <B>
• The cause of this exception as a runtime exception
• An IllegalArgumentException with its cause set to this

Throws:

A - The first possible exception type to throw

B - The second possible exception type to throw

IllegalArgumentException - if the cause is not a RuntimeException or of type A or B

A extends Throwable

asOneOf

public <A extends Throwable,B extends Throwable,C extends Throwable> RuntimeException asOneOf(Class<A> a,
                                                                                              Class<B> b,
                                                                                              Class<C> c)
                                                                                       throws A extends Throwable,
                                                                                              B extends Throwable,
                                                                                              C extends Throwable,
                                                                                              IllegalArgumentException

Throws the cause of this Exception as a RuntimeException or one of the supplied Exception types.

Parameters:

a - The first possible exception type to throw

b - The second possible exception type to throw

c - The third possible exception type to throw

Returns:

This method will always throw an exception, either:

• The cause of this exception as the type <A>
• The cause of this exception as the type <B>
• The cause of this exception as the type <C>
• The cause of this exception as a runtime exception
• An IllegalArgumentException with its cause set to this

Throws:

A - The first possible exception type to throw

B - The second possible exception type to throw

C - The third possible exception type to throw

IllegalArgumentException - if the cause is not a RuntimeException or one of types A, B or C

A extends Throwable

See Also:

asOneOf(Class, Class)

asOneOf

public <A extends Throwable,B extends Throwable,C extends Throwable,D extends Throwable> RuntimeException asOneOf(Class<A> a,
                                                                                                                  Class<B> b,
                                                                                                                  Class<C> c,
                                                                                                                  Class<D> d)
                                                                                                           throws A extends Throwable,
                                                                                                                  B extends Throwable,
                                                                                                                  C extends Throwable,
                                                                                                                  D extends Throwable,
                                                                                                                  IllegalArgumentException

Throws the cause of this Exception as a RuntimeException or one of the supplied Exception types.

Parameters:

a - The first possible exception type to throw

b - The second possible exception type to throw

c - The third possible exception type to throw

d - The fourth possible exception type to throw

Returns:

This method will always throw an exception, either:

• The cause of this exception as the type <A>
• The cause of this exception as the type <B>
• The cause of this exception as the type <C>
• The cause of this exception as a runtime exception
• An IllegalArgumentException with its cause set to this

Throws:

A - The first possible exception type to throw

B - The second possible exception type to throw

C - The third possible exception type to throw

D - The fourth possible exception type to throw

IllegalArgumentException - if the cause is not a RuntimeException or one of types A, B, C or D

A extends Throwable

See Also:

asOneOf(Class, Class)