sila_java.library.server_base.command.observable

Class ObservableCommandWrapper<ParamType,ResultType>

java.lang.Object

sila_java.library.server_base.command.observable.ObservableCommandWrapper<ParamType,ResultType>

Type Parameters:

ParamType -

ResultType -

All Implemented Interfaces:

AutoCloseable

public class ObservableCommandWrapper<ParamType,ResultType>
extends Object
implements AutoCloseable

Wrapper for all observable commands

Method Summary

Modifier and Type	Method and Description
<IntermediateResultType> void	addIntermediateResponseObserver(@NonNull StreamObserver<IntermediateResultType> streamObserver) Add an intermediate response observer
void	addStateObserver(@NonNull StreamObserver<SiLAFramework.ExecutionInfo> streamObserver) Add a command state observer
ResultType	call() Wrapps the command task with appropriate state notifications
void	close() Dispose all resources owned by the wrapper
SiLAFramework.CommandConfirmation	getCommandConfirmation() Retrieving Initial Command Confirmation
boolean	isDone() Return whether or not the command is done
<IntermediateResultType> void	notifyIntermediateResponse(IntermediateResultType intermediateResponse) Notify intermediate response observers an intermediate response
void	sendResult(@NonNull StreamObserver<ResultType> streamObserver) Send command result to an observer or an error if command execution was not successful
void	setExecutionInfoAndNotify(double progressionPercent, Duration estimatedRemainingTime) Set the execution information and notify observers

Methods inherited from class java.lang.Object

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

Method Detail

getCommandConfirmation

public SiLAFramework.CommandConfirmation getCommandConfirmation()

Retrieving Initial Command Confirmation

Returns:

Command Confirmation

call

public ResultType call()
                throws StatusRuntimeException

Wrapps the command task with appropriate state notifications

Returns:

Result if successful

Throws:

StatusRuntimeException

addStateObserver

public void addStateObserver(@NonNull
                             @NonNull StreamObserver<SiLAFramework.ExecutionInfo> streamObserver)

Add a command state observer

Parameters:

streamObserver - The observer

addIntermediateResponseObserver

public <IntermediateResultType> void addIntermediateResponseObserver(@NonNull
                                                                     @NonNull StreamObserver<IntermediateResultType> streamObserver)

Add an intermediate response observer

Parameters:

streamObserver - The observer

sendResult

public void sendResult(@NonNull
                       @NonNull StreamObserver<ResultType> streamObserver)

Send command result to an observer or an error if command execution was not successful

Parameters:

streamObserver - the observer

notifyIntermediateResponse

public <IntermediateResultType> void notifyIntermediateResponse(@NonNull
                                                                IntermediateResultType intermediateResponse)

Notify intermediate response observers an intermediate response

Parameters:

intermediateResponse - The intermediate response to notify

close

public void close()

Dispose all resources owned by the wrapper

Specified by:

close in interface AutoCloseable

isDone

public boolean isDone()

Return whether or not the command is done

Returns:

true if the command is done, otherwise false

setExecutionInfoAndNotify

public void setExecutionInfoAndNotify(double progressionPercent,
                                      @Nullable
                                      Duration estimatedRemainingTime)

Set the execution information and notify observers

Parameters:

progressionPercent - The progression percentage

estimatedRemainingTime - The estimated remaining time