org.crsh.shell.impl.command
Class ToChunkPipeFilter

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

All Implemented Interfaces:

Closeable, Flushable, Consumer<Object>, Filter<Object,Chunk>, InteractionContext<Object>, Pipe<Object>, Producer<Chunk>, ProducerConsumer<Object,Chunk>, ProducerContext<Object>, ScreenContext<Object>

 class ToChunkPipeFilter
extends Object
implements Filter<Object,Chunk>

Field Summary

private ChunkAdapter	ca .
private Filter<Chunk,?>	context .

Constructor Summary

ToChunkPipeFilter()

Method Summary

void	close() Close the producer.
void	flush()
Class<Object>	getConsumedType() Returns the class of the consumed type.
int	getHeight() Returns the screen height in chars.
Class<Chunk>	getProducedType() Returns the class of the produced type.
String	getProperty(String propertyName) Returns a generic property, usually this property is resolved by the shell client.
int	getWidth() Returns the screen width in chars.
void	open(ProducerContext<Chunk> context) Open the producer with the specified context.
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.
void	setPiped(boolean piped) Set the pipe status.
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

context

private Filter<Chunk,?> context

.

ca

private ChunkAdapter ca

.

Constructor Detail

ToChunkPipeFilter

ToChunkPipeFilter()

Method Detail

getProducedType

public Class<Chunk> getProducedType()

Description copied from interface: Producer

Returns the class of the produced type.

Specified by:

getProducedType in interface Producer<Chunk>

Returns:

the produced type

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

setPiped

public void setPiped(boolean piped)

Description copied from interface: Producer

Set the pipe status.

Specified by:

setPiped in interface Producer<Chunk>

Parameters:

piped - the piped status

open

public void open(ProducerContext<Chunk> context)

Description copied from interface: Producer

Open the producer with the specified context.

Specified by:

open in interface Producer<Chunk>

Parameters:

context - the context

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

provide

public void provide(Object element)
             throws ScriptException,
                    IOException

Description copied from interface: Pipe

Provide an element.

Specified by:

provide in interface Pipe<Object>

Parameters:

element - the provided element

Throws:

ScriptException

IOException

flush

public void flush()
           throws ScriptException,
                  IOException

Specified by:

flush in interface Flushable

Throws:

ScriptException

IOException

close

public void close()
           throws ScriptException

Description copied from interface: Producer

Close the producer.

Specified by:

close in interface Closeable

Specified by:

close in interface Producer<Chunk>

Throws:

ScriptException

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