com.palantir.giraffe.command.interactive

Class ShellConversation

java.lang.Object

com.palantir.giraffe.command.interactive.ShellConversation

public final class ShellConversation
extends Object

Asynchronously responds to interactive command execution, as represented by a CommandFuture, using a ResponseProvider.

Constructor Summary

Constructors

Constructor and Description
ShellConversation(ResponseProvider<String> convoScript, CommandFuture commandExecution)

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

ShellConversation

public ShellConversation(ResponseProvider<String> convoScript,
                         CommandFuture commandExecution)

Method Detail

processToken

protected boolean processToken(String matchedToken)
                        throws Exception

Parameters:

matchedToken - The string token

Returns:

true if the token was successfully processed; false otherwise

Throws:

Exception

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.