|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.crsh.shell.impl.command.Pipe<C,P>
class Pipe<C,P>
| Field Summary | |
|---|---|
(package private) Filter<C,P,InteractionContext<P>> |
command
. |
protected CommandContext<P> |
context
. |
| Constructor Summary | |
|---|---|
Pipe(Filter<C,P,InteractionContext<P>> command)
|
|
| Method Summary | |
|---|---|
void |
close()
Close the producer. |
void |
flush()
|
Map<String,Object> |
getAttributes()
Returns the current attributes. |
Class<C> |
getConsumedType()
Returns the class of the element generic type. |
int |
getHeight()
Returns the screen height in chars. |
Class<P> |
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. |
Map<String,Object> |
getSession()
Returns the current session. |
int |
getWidth()
Returns the screen width in chars. |
boolean |
isPiped()
|
void |
open(CommandContext<P> consumer)
Open the producer with the specified consumer. |
void |
provide(C 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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected CommandContext<P> context
final Filter<C,P,InteractionContext<P>> command
| Constructor Detail |
|---|
Pipe(Filter<C,P,InteractionContext<P>> command)
| Method Detail |
|---|
public final boolean takeAlternateBuffer()
throws IOException
InteractionContextFlushable.flush() method
is invoked.
takeAlternateBuffer in interface InteractionContext<C>IOException
public final boolean releaseAlternateBuffer()
throws IOException
InteractionContextFlushable.flush() method
is invoked.
releaseAlternateBuffer in interface InteractionContext<C>IOExceptionpublic final String getProperty(String propertyName)
InteractionContext
getProperty in interface InteractionContext<C>propertyName - the property name
public final String readLine(String msg,
boolean echo)
InteractionContext
readLine in interface InteractionContext<C>msg - the message to display before reading a lineecho - wether or not the line read should be echoed when typing
public final int getWidth()
ScreenContext
getWidth in interface ScreenContext<C>public final int getHeight()
ScreenContext
getHeight in interface ScreenContext<C>public Map<String,Object> getSession()
RuntimeContext
getSession in interface RuntimeContextpublic Map<String,Object> getAttributes()
RuntimeContext
getAttributes in interface RuntimeContextpublic boolean isPiped()
isPiped in interface CommandContext<C>public Class<P> getProducedType()
Producer
getProducedType in interface Producer<P,CommandContext<P>>public Class<C> getConsumedType()
Consumer
getConsumedType in interface Consumer<C>public void open(CommandContext<P> consumer)
Producer
open in interface Producer<P,CommandContext<P>>consumer - the consumer
public void provide(C element)
throws IOException
Consumer
provide in interface Consumer<C>element - the provided element
IOException
public void flush()
throws IOException
flush in interface FlushableIOException
public void close()
throws ScriptException,
IOException
Producer
close in interface Closeableclose in interface Producer<P,CommandContext<P>>ScriptException
IOException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||