org.crsh.command
Interface InvocationContext<C,P>

All Superinterfaces:

CommandContext

public interface InvocationContext<C,P>
extends CommandContext

The invocation context provided to a command during the invocation phase. The invocation context provides the various interactions that a command can perform with its context during its invocation.

Version:

$Revision$

Author:

Julien Viet

Method Summary

Iterable<C>	consume() Returns an iterator over the stream of consumed items.
int	getWidth() Returns the term width in chars.
ShellPrinter	getWriter()
boolean	isPiped() Returns true if the command is involved in a pipe operation and receives a stream.
void	produce(P product)
String	readLine(String msg, boolean echo)

Methods inherited from interface org.crsh.command.CommandContext

getAttributes

Method Detail

getWidth

int getWidth()

Returns the term width in chars. When the value is not positive it means the value could not be determined.

Returns:

the term width

readLine

String readLine(String msg,
                boolean echo)

getWriter

ShellPrinter getWriter()

isPiped

boolean isPiped()

Returns true if the command is involved in a pipe operation and receives a stream.

Returns:

true if the command is involved in a pipe

consume

Iterable<C> consume()
                    throws IllegalStateException

Returns an iterator over the stream of consumed items.

Returns:

the consumed items

Throws:

IllegalStateException - if the command is not involved in a pipe operation

produce

void produce(P product)