org.crsh.shell.impl.command
Class CRaSHProcessContext

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

All Implemented Interfaces:

Closeable, Appendable, CommandContext<Object>, RuntimeContext, InteractionContext, Consumer<Object>, Screenable, ScreenContext

 class CRaSHProcessContext
extends Object
implements CommandContext<Object>, Closeable

Field Summary

private ScreenContextConsumer	adapter .
private ScreenBuffer	buffer .
private ShellProcessContext	processContext .
private CRaSHSession	session .
private boolean	useAlternateBuffer .

Constructor Summary

CRaSHProcessContext(CRaSHSession session, ShellProcessContext processContext)

Method Summary

Screenable	append(char c)
Screenable	append(CharSequence s)
Screenable	append(CharSequence csq, int start, int end)
Screenable	append(Style style)
void	close()
Screenable	cls()
void	flush() Flush the stream.
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.
void	provide(Object element) Provide an element.
String	readLine(String msg, boolean echo) Display a message and read a line on the console, this method call can be blocking until the user provides a value.
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 ScreenContextConsumer adapter

.

buffer

private final ScreenBuffer buffer

.

useAlternateBuffer

private boolean useAlternateBuffer

.

Constructor Detail

CRaSHProcessContext

CRaSHProcessContext(CRaSHSession session,
                    ShellProcessContext processContext)

Method Detail

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 ScreenContext.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 ScreenContext.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)
                throws IOException,
                       InterruptedException

Description copied from interface: InteractionContext

Display a message and read a line on the console, this method call can be blocking until the user provides a value. 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

Throws:

IOException - any io exception

InterruptedException - the thread was interrupted while waiting for the user value

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

append

public Screenable append(CharSequence s)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

append

public Screenable append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

append

public Screenable append(CharSequence csq,
                         int start,
                         int end)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

append

public Screenable append(Style style)
                  throws IOException

Specified by:

append in interface Screenable

Throws:

IOException

cls

public Screenable cls()
               throws IOException

Specified by:

cls in interface Screenable

Throws:

IOException

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

Description copied from interface: Consumer

Flush the stream.

Specified by:

flush in interface Consumer<Object>

Specified by:

flush in interface ScreenContext

Throws:

IOException - any io exception

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

Specified by:

close in interface CommandContext<Object>

Throws:

IOException