org.crsh.shell.impl.command
Class ProcessInvocationContext

java.lang.Object
  org.crsh.shell.impl.command.ProcessInvocationContext

All Implemented Interfaces:

Flushable, Consumer<Object>, InteractionContext<Object>, Pipe<Object>, ProducerContext<Object>, ScreenContext<Object>

 class ProcessInvocationContext
extends Object
implements ProducerContext<Object>

Field Summary

private ChunkAdapter	adapter .
private ShellProcessContext	processContext .
private CRaSHSession	session .

Constructor Summary

ProcessInvocationContext(CRaSHSession session, ShellProcessContext processContext)

Method Summary

void	flush()
Map<String,Object>	getAttributes()
Class<Object>	getConsumedType() Returns the class of the consumed type.
int	getHeight() Returns the screen height in chars.
String	getProperty(String propertyName) Returns a generic property, usually this property is resolved by the shell client.
Map<String,Object>	getSession()
int	getWidth() Returns the screen width in chars.
void	provide(Object element) Provide an element.
String	readLine(String msg, boolean echo) Display a message and read a line on the console.
boolean	releaseAlternateBuffer() Release control of the alternate buffer.
boolean	takeAlternateBuffer() Take control of the alternate buffer.

Methods inherited from class java.lang.Object

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

Field Detail

session

private final CRaSHSession session

.

processContext

private final ShellProcessContext processContext

.

adapter

private final ChunkAdapter adapter

.

Constructor Detail

ProcessInvocationContext

ProcessInvocationContext(CRaSHSession session,
                         ShellProcessContext processContext)

Method Detail

takeAlternateBuffer

public boolean takeAlternateBuffer()

Description copied from interface: InteractionContext

Take control of the alternate buffer. When the alternate buffer is already used nothing happens. The buffer switch should occur when then Flushable.flush() method is invoked.

Specified by:

takeAlternateBuffer in interface InteractionContext<Object>

Returns:

true if the alternate buffer is shown

releaseAlternateBuffer

public boolean releaseAlternateBuffer()

Description copied from interface: InteractionContext

Release control of the alternate buffer. When the normal buffer is already used nothing happens. The buffer switch should occur when then Flushable.flush() method is invoked.

Specified by:

releaseAlternateBuffer in interface InteractionContext<Object>

Returns:

true if the usual buffer is shown

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<Object>

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<Object>

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

getWidth

public int getWidth()

Description copied from interface: ScreenContext

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

Specified by:

getWidth in interface ScreenContext<Object>

Returns:

the term width

getHeight

public int getHeight()

Description copied from interface: ScreenContext

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

Specified by:

getHeight in interface ScreenContext<Object>

Returns:

the term height

getConsumedType

public Class<Object> getConsumedType()

Description copied from interface: Consumer

Returns the class of the consumed type.

Specified by:

getConsumedType in interface Consumer<Object>

Returns:

the consumed type

provide

public void provide(Object element)
             throws IOException

Description copied from interface: Pipe

Provide an element.

Specified by:

provide in interface Pipe<Object>

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()

getAttributes

public Map<String,Object> getAttributes()