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

public interface CommandContext<C,P>

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

Version:

$Revision$

Author:

Julien Viet

Method Summary

java.lang.Iterable<C>	consume() Returns an iterator over the stream of consumed items.
java.util.Map<java.lang.String,java.lang.Object>	getAttributes()
ShellPrinter	getWriter()
boolean	isPiped() Returns true if the command is involved in a pipe operation and receives a stream.
void	produce(P product)
java.lang.String	readLine(java.lang.String msg, boolean echo)

Method Detail

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes()

readLine

java.lang.String readLine(java.lang.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

java.lang.Iterable<C> consume()
                              throws java.lang.IllegalStateException

Returns an iterator over the stream of consumed items.

Returns:

the consumed items

Throws:

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

produce

void produce(P product)