org.crsh.shell.impl.command
Class CRaSHProcessContext

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

All Implemented Interfaces:

Closeable, Flushable, CommandContext<Object>, RuntimeContext, Consumer<Object>, InteractionContext, ScreenContext

 class CRaSHProcessContext
extends Object
implements CommandContext<Object>, Closeable

Field Summary

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

Constructor Summary

CRaSHProcessContext(CRaSHSession session, ShellProcessContext processContext)

Method Summary

void	close()
void	flush()
Map<String,Object>	getAttributes() Returns the current attributes.
Class<Object>	getConsumedType() Returns the class of the element generic 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() Returns the current session.
int	getWidth() Returns the screen width in chars.
boolean	isPiped()
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.
void	write(Chunk chunk) Write a chunk to the screen.

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

.

useAlternateBuffer

private boolean useAlternateBuffer

.

Constructor Detail

CRaSHProcessContext

CRaSHProcessContext(CRaSHSession session,
                    ShellProcessContext processContext)

Method Detail

isPiped

public boolean isPiped()

Specified by:

isPiped in interface CommandContext<Object>

takeAlternateBuffer

public boolean takeAlternateBuffer()
                            throws IOException

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

Returns:

true if the alternate buffer is shown

Throws:

IOException

releaseAlternateBuffer

public boolean releaseAlternateBuffer()
                               throws IOException

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

Returns:

true if the usual buffer is shown

Throws:

IOException

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

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

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

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

Returns:

the term height

getConsumedType

public Class<Object> getConsumedType()

Description copied from interface: Consumer

Returns the class of the element generic type.

Specified by:

getConsumedType in interface Consumer<Object>

Returns:

the consumed type

write

public void write(Chunk chunk)
           throws IOException

Description copied from interface: ScreenContext

Write a chunk to the screen.

Specified by:

write in interface ScreenContext

Parameters:

chunk - the chunk

Throws:

IOException - any io exception

provide

public void provide(Object element)
             throws IOException

Description copied from interface: Consumer

Provide an element.

Specified by:

provide in interface Consumer<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()

Description copied from interface: RuntimeContext

Returns the current session.

Specified by:

getSession in interface RuntimeContext

Returns:

the session map

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: RuntimeContext

Returns the current attributes.

Specified by:

getAttributes in interface RuntimeContext

Returns:

the attributes map

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Throws:

IOException