org.crsh.command

Class InvocationContextImpl<P>

java.lang.Object

org.crsh.command.InvocationContextImpl<P>

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, CommandContext<P>, InvocationContext<P>, RuntimeContext, Consumer<P>, InteractionContext, ScreenContext

public final class InvocationContextImpl<P>
extends java.lang.Object
implements InvocationContext<P>

Constructor Summary

Constructors

Constructor and Description
InvocationContextImpl(CommandContext<P> commandContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	flush()
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Returns the current attributes.
java.lang.Class<P>	getConsumedType() Returns the class of the element generic type.
int	getHeight() Returns the screen height in chars.
java.lang.String	getProperty(java.lang.String propertyName) Returns a generic property, usually this property is resolved by the shell client.
java.util.Map<java.lang.String,java.lang.Object>	getSession() Returns the current session.
int	getWidth() Returns the screen width in chars.
RenderPrintWriter	getWriter() Returns the writer for the output.
boolean	isPiped()
InvocationContextImpl<P>	leftShift(java.lang.Object o)
void	provide(P element) Provide an element.
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.
CommandInvoker<?,?>	resolve(java.lang.String s) Resolve a command invoker for the specified command line.
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

Constructor Detail

InvocationContextImpl

public InvocationContextImpl(CommandContext<P> commandContext)

Method Detail

isPiped

public boolean isPiped()

Specified by:

isPiped in interface CommandContext<P>

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

takeAlternateBuffer

public boolean takeAlternateBuffer()
                            throws java.io.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:

java.io.IOException

releaseAlternateBuffer

public boolean releaseAlternateBuffer()
                               throws java.io.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:

java.io.IOException

resolve

public CommandInvoker<?,?> resolve(java.lang.String s)
                            throws ScriptException,
                                   java.io.IOException

Description copied from interface: InvocationContext

Resolve a command invoker for the specified command line.

Specified by:

resolve in interface InvocationContext<P>

Parameters:

s - the command line

Returns:

the command invoker

Throws:

ScriptException - any script exception

java.io.IOException - any io exception

getConsumedType

public java.lang.Class<P> getConsumedType()

Description copied from interface: Consumer

Returns the class of the element generic type.

Specified by:

getConsumedType in interface Consumer<P>

Returns:

the consumed type

getProperty

public java.lang.String getProperty(java.lang.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 java.lang.String readLine(java.lang.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

write

public void write(Chunk chunk)
           throws java.io.IOException

Description copied from interface: ScreenContext

Write a chunk to the screen.

Specified by:

write in interface ScreenContext

Parameters:

chunk - the chunk

Throws:

java.io.IOException - any io exception

provide

public void provide(P element)
             throws java.io.IOException

Description copied from interface: Consumer

Provide an element.

Specified by:

provide in interface Consumer<P>

Parameters:

element - the provided element

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getSession

public java.util.Map<java.lang.String,java.lang.Object> getSession()

Description copied from interface: RuntimeContext

Returns the current session.

Specified by:

getSession in interface RuntimeContext

Returns:

the session map

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Description copied from interface: RuntimeContext

Returns the current attributes.

Specified by:

getAttributes in interface RuntimeContext

Returns:

the attributes map

leftShift

public InvocationContextImpl<P> leftShift(java.lang.Object o)
                                   throws java.io.IOException

Throws:

java.io.IOException