org.crsh.command
Class InnerInvocationContext<P>

java.lang.Object
  org.crsh.command.InnerInvocationContext<P>

All Implemented Interfaces:

Flushable, CommandContext, InvocationContext<P>, InteractionContext<P>, Pipe<P>

 class InnerInvocationContext<P>
extends Object
implements InvocationContext<P>

Field Summary

(package private) InvocationContext<?>	outter .
(package private) Pipe<Object>	producer .
private RenderPrintWriter	writer .

Constructor Summary

InnerInvocationContext(InvocationContext<?> outter, Pipe<Object> producer)

Method Summary

void	flush()
Map<String,Object>	getAttributes() Returns the current shell attributes.
int	getHeight() Returns the term height in chars.
String	getProperty(String propertyName) Returns a generic property, usually this property is resolved by the shell client.
Map<String,Object>	getSession() Returns the current shell session.
int	getWidth() Returns the term width in chars.
RenderPrintWriter	getWriter() Returns the writer for the output.
void	provide(P element) Provide an element.
String	readLine(String msg, boolean echo) Display a message and read a line on the console.

Methods inherited from class java.lang.Object

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

Field Detail

outter

final InvocationContext<?> outter

.

producer

final Pipe<Object> producer

.

writer

private RenderPrintWriter writer

.

Constructor Detail

InnerInvocationContext

InnerInvocationContext(InvocationContext<?> outter,
                       Pipe<Object> producer)

Method Detail

getWidth

public int getWidth()

Description copied from interface: InteractionContext

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

Specified by:

getWidth in interface InteractionContext<P>

Returns:

the term width

getHeight

public int getHeight()

Description copied from interface: InteractionContext

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

Specified by:

getHeight in interface InteractionContext<P>

Returns:

the term height

getProperty

public String getProperty(String propertyName)

Description copied from interface: InteractionContext

Returns a generic property, usually this property is resolved by the shell client.

Specified by:

getProperty in interface InteractionContext<P>

Parameters:

propertyName - the property name

Returns:

the property value

readLine

public String readLine(String msg,
                       boolean echo)

Description copied from interface: InteractionContext

Display a message and read a line on the console. If no line can be read then null is returned.

Specified by:

readLine in interface InteractionContext<P>

Parameters:

msg - the message to display before reading a line

echo - wether or not the line read should be echoed when typing

Returns:

the line read

getWriter

public RenderPrintWriter getWriter()

Description copied from interface: InvocationContext

Returns the writer for the output.

Specified by:

getWriter in interface InvocationContext<P>

Returns:

the writer

provide

public void provide(P element)
             throws IOException

Description copied from interface: Pipe

Provide an element.

Specified by:

provide in interface Pipe<P>

Parameters:

element - the provided element

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

getSession

public Map<String,Object> getSession()

Description copied from interface: CommandContext

Returns the current shell session.

Specified by:

getSession in interface CommandContext

Returns:

the session map

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: CommandContext

Returns the current shell attributes.

Specified by:

getAttributes in interface CommandContext

Returns:

the attributes map