com.palantir.giraffe.command.interactive

Class CommandOutputTrigger

java.lang.Object

com.palantir.giraffe.command.interactive.CommandOutputTrigger

public final class CommandOutputTrigger
extends Object

Listens on long-running commands and runs Runnables when certain output appears.

Constructor Summary

Constructors

Constructor and Description
CommandOutputTrigger(ResponseProvider<Runnable> callbackMap, CommandFuture commandExecution) Create a CommandOutputTrigger for a running command using the provided ResponseProvider.
CommandOutputTrigger(ResponseProvider<Runnable> callbackMap, CommandFuture commandExecution, Executor executor) Create a CommandOutputTrigger for a running command using the provided ResponseProvider.

Method Summary

Modifier and Type	Method and Description
protected boolean	processToken(String matchedToken)
Future<Void>	start() Asynchronously starts an interaction.
Future<Void>	start(String tokenDelimiterRegex) Asynchronously starts an interaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandOutputTrigger

public CommandOutputTrigger(ResponseProvider<Runnable> callbackMap,
                            CommandFuture commandExecution)

Create a CommandOutputTrigger for a running command using the provided ResponseProvider. By default, the Runnable obtained from the ResponseProvider will be executed by the same thread.

Parameters:

callbackMap - The ResponseProvider to use

commandExecution - The executing command

CommandOutputTrigger

public CommandOutputTrigger(ResponseProvider<Runnable> callbackMap,
                            CommandFuture commandExecution,
                            Executor executor)

Create a CommandOutputTrigger for a running command using the provided ResponseProvider. The Runnable obtained from the ResponseProvider will be executed by the provided Executor.

Parameters:

callbackMap - The ResponseProvider to use

commandExecution - The executing command

executor - The executor to use for executing the Runnables

Method Detail

processToken

protected boolean processToken(String matchedToken)

Parameters:

matchedToken - The string token

Returns:

true if the token was successfully processed; false otherwise

start

public final Future<Void> start()

Asynchronously starts an interaction. Input is tokenized by line (any string of text ending in \r, \n, or \r\n). Calling start again has no effect.

Returns:

A Future<?> which represents the asynchronous execution of the stream processing.

start

public final Future<Void> start(String tokenDelimiterRegex)

Asynchronously starts an interaction. Input is tokenized by the provided regular expression. Calling start again has no effect.

Returns:

A Future<?> which represents the asynchronous execution of the stream processing.