VirtualTerminal

Instance Constructors

new VirtualTerminal(inputQueue: BlockingQueue[String] = ..., outputQueue: BlockingQueue[String] = ..., waitTime: Long = DefaultWaitTime)

inputQueue
The queue used for new input to the terminal
outputQueue
The queue used for new output from the terminal
waitTime
The maximum time to wait for retrieving input as well as wait to add new input (in milliseconds); if negative, will wait indefinitely

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getPromptFunction: () ⇒ String

Returns the function used to generate prompts.
Returns the function used to generate prompts.
returns
The prompt function

Definition Classes
Terminal
def hashCode(): Int

Definition Classes
AnyRef → Any
def history: HistoryManager

Returns the manager used to keep track of this terminal's history.
Returns the manager used to keep track of this terminal's history.

Definition Classes
VirtualTerminal → Terminal
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newInputLine(text: String): Unit

Adds a new line of input to be fed into the terminal.
Adds a new line of input to be fed into the terminal.
text
The new line of text

Annotations
@throws( ... )
Exceptions thrown
IllegalStateException When maximum output queue capacity has been reached and is full for longer than the maximum wait time
def nextOutputLine(waitTime: Long = 0): Option[String]

Retrieves the next line of output from the terminal.
Retrieves the next line of output from the terminal.
waitTime
The maximum time to wait for new output in milliseconds, or -1 if waiting indefinitely
returns
Some new line of output from the terminal if output exists, otherwise None
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def prompt(): String

Retrieves the prompt by invoking the prompt function.
Retrieves the prompt by invoking the prompt function.
returns
The new string prompt

Definition Classes
Terminal
def readLine(): Option[String]

Reads the next line from the terminal.
Reads the next line from the terminal.
returns
Some line if found, otherwise None if the maximum time allowed for new input has been exceeded

Definition Classes
VirtualTerminal → Terminal
def setPrompt(prompt: String): Unit

Sets a static prompt for the terminal.
Sets a static prompt for the terminal.
prompt
The static prompt string

Definition Classes
Terminal
def setPromptFunction(promptFunc: () ⇒ String): Unit

Sets a dynamic prompt using a prompt function.
Sets a dynamic prompt using a prompt function.
promptFunc
The new prompt function

Definition Classes
Terminal
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def write(text: String): Unit

Writes the provided text to the terminal.
Writes the provided text to the terminal.
text
The text to write out to the terminal

Definition Classes
VirtualTerminal → Terminal
Annotations
@throws( ... )
Exceptions thrown
IllegalStateException When the output queue's capacity has been reached
def writeLine(text: String): Unit

Writes the provided text to the terminal and ends with a newline character.
Writes the provided text to the terminal and ends with a newline character.
text
The text to write out to the terminal

Definition Classes
Terminal

Related Docs: object VirtualTerminal | package frontend

class VirtualTerminal extends Terminal

Instance Constructors

new VirtualTerminal(inputQueue: BlockingQueue[String] = ..., outputQueue: BlockingQueue[String] = ..., waitTime: Long = DefaultWaitTime)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getPromptFunction: () ⇒ String

def hashCode(): Int

def history: HistoryManager

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def newInputLine(text: String): Unit

def nextOutputLine(waitTime: Long = 0): Option[String]

final def notify(): Unit

final def notifyAll(): Unit

def prompt(): String

def readLine(): Option[String]

def setPrompt(prompt: String): Unit

def setPromptFunction(promptFunc: () ⇒ String): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def write(text: String): Unit

def writeLine(text: String): Unit

Inherited from Terminal

Inherited from AnyRef

Inherited from Any

Ungrouped