org.crsh.shell

Interface InteractionContext

All Superinterfaces:

java.io.Flushable, ScreenContext

All Known Subinterfaces:

CommandContext<P>, InvocationContext<P>, ShellProcessContext

All Known Implementing Classes:

AbstractPipe, ConvertingPipe, InvocationContextImpl, ToChunkPipe

public interface InteractionContext
extends ScreenContext

The interaction context extends the screen context and provides interaction with the client.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getProperty(java.lang.String propertyName) Returns a generic property, usually this property is resolved by the shell client.
java.lang.String	readLine(java.lang.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 interface org.crsh.shell.ScreenContext

getHeight, getWidth, write

Methods inherited from interface java.io.Flushable

flush

Method Detail

takeAlternateBuffer

boolean takeAlternateBuffer()
                            throws java.io.IOException

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.

Returns:

true if the alternate buffer is shown

Throws:

java.io.IOException

releaseAlternateBuffer

boolean releaseAlternateBuffer()
                               throws java.io.IOException

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.

Returns:

true if the usual buffer is shown

Throws:

java.io.IOException

getProperty

java.lang.String getProperty(java.lang.String propertyName)

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

Parameters:

propertyName - the property name

Returns:

the property value

readLine

java.lang.String readLine(java.lang.String msg,
                        boolean echo)

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

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