org.crsh.term.console

Class ConsoleTerm

java.lang.Object

org.crsh.term.console.ConsoleTerm

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, ScreenContext, Term

public class ConsoleTerm
extends java.lang.Object
implements Term

Implements the interface.

Constructor Summary

Constructors

Constructor and Description
ConsoleTerm(TermIO io)

Method Summary

Methods

Modifier and Type	Method and Description
void	addToHistory(java.lang.CharSequence line) Append a line to the term history.
void	close()
void	flush()
java.lang.CharSequence	getBuffer() Returns the current buffer content to the cursor;
java.lang.Class<Chunk>	getConsumedType()
java.lang.Appendable	getDirectBuffer() Returns the direct buffer, any char appended in the returned appendable will translate into an insertion in the buffer.
int	getHeight() Returns the screen height in chars.
java.lang.String	getProperty(java.lang.String name) Retrieves the value of a property specified by this Term
int	getWidth() Returns the screen width in chars.
void	provide(Chunk element)
TermEvent	read() Read the next term event.
boolean	releaseAlternateBuffer() Release control of the alternate buffer.
void	setEcho(boolean echo) Set the echo mode on the term.
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

ConsoleTerm

public ConsoleTerm(TermIO io)

Method Detail

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

getProperty

public java.lang.String getProperty(java.lang.String name)

Description copied from interface: Term

Retrieves the value of a property specified by this Term

Specified by:

getProperty in interface Term

Parameters:

name - name of the term property

Returns:

value of the term property

setEcho

public void setEcho(boolean echo)

Description copied from interface: Term

Set the echo mode on the term.

Specified by:

setEcho in interface Term

Parameters:

echo - the echo mode

takeAlternateBuffer

public boolean takeAlternateBuffer()
                            throws java.io.IOException

Description copied from interface: Term

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 Term

Returns:

true if the alternate buffer is shown

Throws:

java.io.IOException

releaseAlternateBuffer

public boolean releaseAlternateBuffer()
                               throws java.io.IOException

Description copied from interface: Term

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 Term

Returns:

true if the usual buffer is shown

Throws:

java.io.IOException

read

public TermEvent read()
               throws java.io.IOException

Description copied from interface: Term

Read the next term event. This operation is a blocking operation that blocks until data is available or until term is closed.

Specified by:

read in interface Term

Returns:

the next term event

Throws:

java.io.IOException - any io exception

getDirectBuffer

public java.lang.Appendable getDirectBuffer()

Description copied from interface: Term

Returns the direct buffer, any char appended in the returned appendable will translate into an insertion in the buffer.

Specified by:

getDirectBuffer in interface Term

Returns:

the insert buffer.

addToHistory

public void addToHistory(java.lang.CharSequence line)

Description copied from interface: Term

Append a line to the term history.

Specified by:

addToHistory in interface Term

Parameters:

line - the history line to append

getBuffer

public java.lang.CharSequence getBuffer()

Description copied from interface: Term

Returns the current buffer content to the cursor;

Specified by:

getBuffer in interface Term

Returns:

the buffer

flush

public void flush()

Specified by:

flush in interface java.io.Flushable

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

getConsumedType

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

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(Chunk element)
             throws java.io.IOException

Throws:

java.io.IOException