com.helger.commons.callback.adapter

Class AdapterRunnableToCallableWithParameter<DATATYPE,PARAMTYPE>

java.lang.Object

com.helger.commons.callback.adapter.AdapterRunnableToCallableWithParameter<DATATYPE,PARAMTYPE>

Type Parameters:

DATATYPE - The callable result type.

PARAMTYPE - The parameter type.

All Implemented Interfaces:

INonThrowingCallableWithParameter<DATATYPE,PARAMTYPE>, IThrowingCallableWithParameter<DATATYPE,PARAMTYPE>

@Immutable
public class AdapterRunnableToCallableWithParameter<DATATYPE,PARAMTYPE>
extends Object
implements INonThrowingCallableWithParameter<DATATYPE,PARAMTYPE>

A helper class that converts a INonThrowingRunnableWithParameter into an INonThrowingCallableWithParameter.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AdapterRunnableToCallableWithParameter(INonThrowingRunnableWithParameter<PARAMTYPE> aRunnable)
AdapterRunnableToCallableWithParameter(INonThrowingRunnableWithParameter<PARAMTYPE> aRunnable, DATATYPE aResult)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AdapterRunnableToCallableWithParameter

public AdapterRunnableToCallableWithParameter(@Nonnull
                                      INonThrowingRunnableWithParameter<PARAMTYPE> aRunnable)

AdapterRunnableToCallableWithParameter

public AdapterRunnableToCallableWithParameter(@Nonnull
                                      INonThrowingRunnableWithParameter<PARAMTYPE> aRunnable,
                                      @Nullable
                                      DATATYPE aResult)

Method Detail

getRunnable

@Nonnull
public INonThrowingRunnableWithParameter<PARAMTYPE> getRunnable()

getResult

@Nullable
public DATATYPE getResult()

call

@Nullable
public DATATYPE call(PARAMTYPE aParam)

Description copied from interface: INonThrowingCallableWithParameter

The call back method to be called.

Specified by:

call in interface INonThrowingCallableWithParameter<DATATYPE,PARAMTYPE>

Specified by:

call in interface IThrowingCallableWithParameter<DATATYPE,PARAMTYPE>

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.

toString

public String toString()

Overrides:

toString in class Object

createAdapter

@Nonnull
public static <PARAMTYPE> AdapterRunnableToCallableWithParameter<Object,PARAMTYPE> createAdapter(@Nonnull
                                                                                         INonThrowingRunnableWithParameter<PARAMTYPE> aRunnable)

Create a callable that always returns null.

Type Parameters:

PARAMTYPE - The parameter type.

Parameters:

aRunnable - The runnable to be executed.

Returns:

The created AdapterRunnableToCallableWithParameter object.

createAdapter

@Nonnull
public static <DATATYPE,PARAMTYPE> AdapterRunnableToCallableWithParameter<DATATYPE,PARAMTYPE> createAdapter(@Nonnull
                                                                                                    INonThrowingRunnableWithParameter<PARAMTYPE> aRunnable,
                                                                                                    @Nullable
                                                                                                    DATATYPE aResult)

Create a callable that always returns the passed value.

Type Parameters:

DATATYPE - The callable result type.

PARAMTYPE - The parameter type.

Parameters:

aRunnable - The runnable to be executed.

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

Returns:

The created AdapterRunnableToCallableWithParameter object.