RemoteMethod.FuturePreparator¶

public static abstract class FuturePreparator<FutureDataType>¶

Instances of this class are used to prepare a Future instance containing the desired result of the client from the reply Event instance.

Author: jwienke
Parameters: <FutureDataType> – the data type of the contents inside the result future

Constructors¶

FuturePreparator¶

public FuturePreparator(Future<FutureDataType> future)¶

Creates a new instance with a Future instance that is eventually passed to the client. Internally a WeakReference will be used to track this future. This allows the client to ignore the result future in a way that we sometimes can notice this and avoid additional work.

Parameters: future – the future to contain the final result.

Methods¶

error¶

public void error(Throwable error)¶

Method called in case of an error. The default implementation directly passes the given Throwable to the the Future.error(Throwable) method.

Parameters: error – exception explaining the error

getFuture¶

public Future<FutureDataType> getFuture()¶

Returns the future where the result should be prepared for.

Returns: Future instance or null if the client does not hold a reference on this future anymore. In such a case nothing needs to be done.

result¶

public abstract void result(Event resultEvent)¶

This method needs to be implemented with the conversion logic from the Event instance with the result to the final Future interface.

Parameters: resultEvent – result event from the server call