org.lsst.ccs.subsystem.bonnshutter.main

Class CommandExecutor

java.lang.Object

org.lsst.ccs.subsystem.bonnshutter.main.CommandExecutor

public class CommandExecutor
extends Object

A class to make it easier to execute commands while correctly handling ACKS, NACKS, and exceptions.

Author:

tonyj

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandExecutor.CommandFailedException
static interface	CommandExecutor.RunnableWithException

Constructor Summary

Constructors

Constructor and Description
CommandExecutor(org.lsst.ccs.Agent subsys)

Method Summary

Modifier and Type	Method and Description
<T> T	action(Callable<T> callable) Executes the specified callable.
void	action(CommandExecutor.RunnableWithException runnable)
CommandExecutor	precondition(boolean ok) A simple precondition.
CommandExecutor	precondition(boolean ok, String reason, Object... args) A precondition with a reason.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandExecutor

public CommandExecutor(org.lsst.ccs.Agent subsys)

Method Detail

precondition

public CommandExecutor precondition(boolean ok)

A simple precondition.

Parameters:

ok - If false command will not proceed

Returns:

The CommandExecutor, to allow method chaining

precondition

public CommandExecutor precondition(boolean ok,
                                    String reason,
                                    Object... args)

A precondition with a reason.

Parameters:

ok - If false command will not proceed

reason - The reason to use if precondition is not met

args - If present then reason is interpreted as a format string, and args are substituted into the format

Returns:

The CommandExecutor, to allow method chaining

action

public <T> T action(Callable<T> callable)

Executes the specified callable. Designed to be the last method on the method chain.

Type Parameters:

T - The return type of the callable

Parameters:

callable - The callable to call

Returns:

The result of the callable

action

public void action(CommandExecutor.RunnableWithException runnable)