com.helger.commons.callback.adapter

Class AdapterThrowingRunnableToCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE extends Exception>

java.lang.Object

com.helger.commons.callback.adapter.AdapterThrowingRunnableToCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE>

Type Parameters:

DATATYPE - The callable result type.

PARAMTYPE - The parameter type

EXTYPE - Exception type to be thrown

All Implemented Interfaces:

IThrowingCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE>

@Immutable
public class AdapterThrowingRunnableToCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE extends Exception>
extends Object
implements IThrowingCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE>

A helper class that converts a IThrowingRunnable into an IThrowingCallable.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AdapterThrowingRunnableToCallableWithParameter(IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable)
AdapterThrowingRunnableToCallableWithParameter(IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable, DATATYPE aResult)

Method Summary

Modifier and Type	Method and Description
DATATYPE	call(PARAMTYPE aParam) The call back method to be called.
static <PARAMTYPE,EXTYPE extends Exception> AdapterThrowingRunnableToCallableWithParameter<Object,PARAMTYPE,EXTYPE>	createAdapter(IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable) Create a callable that always returns null.
static <DATATYPE,PARAMTYPE,EXTYPE extends Exception> AdapterThrowingRunnableToCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE>	createAdapter(IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable, DATATYPE aResult) Create a callable that always returns the passed value.
DATATYPE	getResult()
IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE>	getRunnable()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdapterThrowingRunnableToCallableWithParameter

public AdapterThrowingRunnableToCallableWithParameter(@Nonnull
                                                      IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable)

AdapterThrowingRunnableToCallableWithParameter

public AdapterThrowingRunnableToCallableWithParameter(@Nonnull
                                                      IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable,
                                                      @Nullable
                                                      DATATYPE aResult)

Method Detail

getRunnable

@Nonnull
public IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> getRunnable()

getResult

@Nullable
public DATATYPE getResult()

call

@Nullable
public DATATYPE call(PARAMTYPE aParam)
                         throws EXTYPE extends Exception

Description copied from interface: IThrowingCallableWithParameter

The call back method to be called.

Specified by:

call in interface IThrowingCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE extends Exception>

Parameters:

aParam - The parameter to be passed in. May be null or non- null depending on the implementation.

Returns:

Anything. May be null or non- null depending on the implementation.

Throws:

EXTYPE - in case something goes wrong

EXTYPE extends Exception

toString

public String toString()

Overrides:

toString in class Object

createAdapter

@Nonnull
public static <PARAMTYPE,EXTYPE extends Exception> AdapterThrowingRunnableToCallableWithParameter<Object,PARAMTYPE,EXTYPE> createAdapter(@Nonnull
                                                                                                                                                   IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable)

Create a callable that always returns null.

Type Parameters:

PARAMTYPE - The parameter type.

EXTYPE - Exception type to be thrown

Parameters:

aRunnable - The runnable to be executed.

Returns:

The created AdapterThrowingRunnableToCallableWithParameter object.

createAdapter

@Nonnull
public static <DATATYPE,PARAMTYPE,EXTYPE extends Exception> AdapterThrowingRunnableToCallableWithParameter<DATATYPE,PARAMTYPE,EXTYPE> createAdapter(@Nonnull
                                                                                                                                                              IThrowingRunnableWithParameter<PARAMTYPE,EXTYPE> aRunnable,
                                                                                                                                                              @Nullable
                                                                                                                                                              DATATYPE aResult)

Create a callable that always returns the passed value.

Type Parameters:

DATATYPE - The callable result type.

PARAMTYPE - The parameter type.

EXTYPE - Exception type to be thrown

Parameters:

aRunnable - The runnable to be executed.

aResult - The expected result from calling IThrowingCallable.call() . May be null.

Returns:

The created AdapterThrowingRunnableToCallableWithParameter object.