|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InteractionContext
The interaction context extends the screen context and provides interaction with the client.
Method Summary | |
---|---|
String |
getProperty(String propertyName)
Returns a generic property, usually this property is resolved by the shell client. |
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 interface org.crsh.text.ScreenContext |
---|
flush, getHeight, getWidth |
Methods inherited from interface org.crsh.text.Screenable |
---|
append, cls |
Methods inherited from interface java.lang.Appendable |
---|
append, append, append |
Method Detail |
---|
boolean takeAlternateBuffer() throws IOException
ScreenContext.flush()
method
is invoked.
IOException
boolean releaseAlternateBuffer() throws IOException
ScreenContext.flush()
method
is invoked.
IOException
String getProperty(String propertyName)
propertyName
- the property name
String readLine(String msg, boolean echo) throws IOException, InterruptedException, IllegalStateException
msg
- the message to display before reading a lineecho
- wether or not the line read should be echoed when typing
IOException
- any io exception
InterruptedException
- the thread was interrupted while waiting for the user value
IllegalStateException
- if reading a line is not at the appropriate time
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |