TerminalImpl (nvt4j 1.2.0 API)

java.lang.Object
- org.dellroad.nvt4j.impl.TerminalImpl

All Implemented Interfaces:: Terminal

public class TerminalImpl
extends Object
implements Terminal

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTO_WRAP_OFF`
`static String`	`AUTO_WRAP_ON`
`static String`	`CLEAR_SCREEN`
`static String`	`CURSOR_OFF`
`static String`	`CURSOR_ON`
`static String`	`MOVE`

Constructor Summary

Constructors
Constructor and Description

TerminalImpl(InputStream in, OutputStream out)

TerminalImpl(Socket socket)

Constructors
Constructor and Description
`TerminalImpl(InputStream in, OutputStream out)`
`TerminalImpl(Socket socket)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the screen.
`void`	`close()` Closes the terminal.
`void`	`flush()` Sends all characters in the buffer (if any) to the terminal.
`int`	`get()` Returns the next character sent by the terminal, or -1 if the stream is closed.
`int`	`get(byte[] buf)` Reads some characters from the terminal and writes them to buffer 'buf' starting from position 0, and returns the number of characters read, or -1 if the stream is closed.
`int`	`get(byte[] buf, int off, int len)` Reads up to 'len' characters from the terminal and writes them to buffer 'buf' starting from position 'off', and returns the number of characters read, or -1 if the stream is closed.
`int`	`getColumns()` Returns the number of columns in the terminal emulator window.
`int`	`getRows()` Returns the number of rows in the terminal emulator window.
`void`	`move(int row, int column)` Sends the terminal emulator a command to move the cursor to the given row and column.
`void`	`put(byte c)` Writes one character to the terminal.
`void`	`put(byte[] buf)` Writes buffer 'buf' to the terminal.
`void`	`put(byte[] buf, int off, int len)` Writes 'len' characters to the terminal, starting from position 'off'.
`void`	`put(char c)` Writes one character to the terminal.
`void`	`put(int c)` Writes one character to the terminal.
`void`	`put(int row, int column, byte c)` Moves the cursor and writes one character to the terminal.
`void`	`put(int row, int column, byte[] buf)` Moves the cursor and writes buffer 'buf' to the terminal.
`void`	`put(int row, int column, byte[] buf, int off, int len)` Moves the cursor and writes 'len' characters to the terminal, starting from position 'off'.
`void`	`put(int row, int column, char c)` Moves the cursor and writes one character to the terminal.
`void`	`put(int row, int column, int c)` Moves the cursor and writes one character to the terminal.
`void`	`put(int row, int column, String s)` Moves the cursor and writes a string to the terminal.
`void`	`put(String s)` Writes a string to the terminal.
`void`	`resize(int rows, int columns)`
`void`	`setCursor(boolean on)` Turns the terminal emulator's cursor on or off.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLEAR_SCREEN
```
public static final String CLEAR_SCREEN
```
    See Also:
    Constant Field Values
  - CURSOR_OFF
```
public static final String CURSOR_OFF
```
    See Also:
    Constant Field Values
  - CURSOR_ON
```
public static final String CURSOR_ON
```
    See Also:
    Constant Field Values
  - MOVE
```
public static final String MOVE
```
    See Also:
    Constant Field Values
  - AUTO_WRAP_OFF
```
public static final String AUTO_WRAP_OFF
```
    See Also:
    Constant Field Values
  - AUTO_WRAP_ON
```
public static final String AUTO_WRAP_ON
```
    See Also:
    Constant Field Values
- Constructor Detail
  - TerminalImpl
```
public TerminalImpl(Socket socket)
             throws IOException
```
    Throws:
    
    IOException
  - TerminalImpl
```
public TerminalImpl(InputStream in,
            OutputStream out)
             throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - getRows
```
public int getRows()
```
    Description copied from interface: Terminal
    
    Returns the number of rows in the terminal emulator window. If the window is resized this value is updated accordingly.
    
    Specified by:
    
    getRows in interface Terminal
  - getColumns
```
public int getColumns()
```
    Description copied from interface: Terminal
    
    Returns the number of columns in the terminal emulator window. If the window is resized this value is updated accordingly.
    
    Specified by:
    
    getColumns in interface Terminal
  - resize
```
public void resize(int rows,
          int columns)
```
  - setCursor
```
public void setCursor(boolean on)
               throws IOException
```
    Description copied from interface: Terminal
    
    Turns the terminal emulator's cursor on or off.
    
    Specified by:
    
    setCursor in interface Terminal
    
    Throws:
    
    IOException
  - clear
```
public void clear()
           throws IOException
```
    Description copied from interface: Terminal
    
    Clears the screen.
    
    Specified by:
    
    clear in interface Terminal
    
    Throws:
    
    IOException
  - get
```
public int get()
        throws IOException
```
    Description copied from interface: Terminal
    
    Returns the next character sent by the terminal, or -1 if the stream is closed. The terminal is in 'raw' mode, not line-buffered mode. This method blocks until a character is available.
    
    Specified by:
    
    get in interface Terminal
    
    Throws:
    
    IOException
  - get
```
public int get(byte[] buf)
        throws IOException
```
    Description copied from interface: Terminal
    
    Reads some characters from the terminal and writes them to buffer 'buf' starting from position 0, and returns the number of characters read, or -1 if the stream is closed. This method blocks until a character is available. The terminal is in 'raw' mode, not line-buffered mode.
    
    Specified by:
    
    get in interface Terminal
    
    Throws:
    
    IOException
  - get
```
public int get(byte[] buf,
      int off,
      int len)
        throws IOException
```
    Description copied from interface: Terminal
    
    Reads up to 'len' characters from the terminal and writes them to buffer 'buf' starting from position 'off', and returns the number of characters read, or -1 if the stream is closed. This method blocks until a character is available. The terminal is in 'raw' mode, not line-buffered mode.
    
    Specified by:
    
    get in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(byte[] buf,
       int off,
       int len)
         throws IOException
```
    Description copied from interface: Terminal
    
    Writes 'len' characters to the terminal, starting from position 'off'.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(byte[] buf)
         throws IOException
```
    Description copied from interface: Terminal
    
    Writes buffer 'buf' to the terminal.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(String s)
         throws IOException
```
    Description copied from interface: Terminal
    
    Writes a string to the terminal. The characters are extracted from the string using the method String.getBytes(), which translates each (2-byte) unicode character to a byte.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(int c)
         throws IOException
```
    Description copied from interface: Terminal
    
    Writes one character to the terminal. The int is converted into a byte by casting.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(char c)
         throws IOException
```
    Description copied from interface: Terminal
    
    Writes one character to the terminal. The char is converted into a byte by casting.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(byte c)
         throws IOException
```
    Description copied from interface: Terminal
    
    Writes one character to the terminal.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(int row,
       int column,
       byte[] buf,
       int off,
       int len)
         throws IOException
```
    Description copied from interface: Terminal
    
    Moves the cursor and writes 'len' characters to the terminal, starting from position 'off'.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(int row,
       int column,
       byte[] buf)
         throws IOException
```
    Description copied from interface: Terminal
    
    Moves the cursor and writes buffer 'buf' to the terminal.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(int row,
       int column,
       String s)
         throws IOException
```
    Description copied from interface: Terminal
    
    Moves the cursor and writes a string to the terminal. The characters are extracted from the string using the method String.getBytes(), which translates each (2-byte) unicode character to a byte.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(int row,
       int column,
       int c)
         throws IOException
```
    Description copied from interface: Terminal
    
    Moves the cursor and writes one character to the terminal. The int is converted into a byte by casting.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(int row,
       int column,
       char c)
         throws IOException
```
    Description copied from interface: Terminal
    
    Moves the cursor and writes one character to the terminal. The char is converted into a byte by casting.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - put
```
public void put(int row,
       int column,
       byte c)
         throws IOException
```
    Description copied from interface: Terminal
    
    Moves the cursor and writes one character to the terminal.
    
    Specified by:
    
    put in interface Terminal
    
    Throws:
    
    IOException
  - flush
```
public void flush()
           throws IOException
```
    Description copied from interface: Terminal
    
    Sends all characters in the buffer (if any) to the terminal.
    
    Specified by:
    
    flush in interface Terminal
    
    Throws:
    
    IOException
  - move
```
public void move(int row,
        int column)
          throws IOException
```
    Description copied from interface: Terminal
    
    Sends the terminal emulator a command to move the cursor to the given row and column. The row must be between 1 and the value of getRows(), while the column must be between 1 and the value of getColumn().
    
    Specified by:
    
    move in interface Terminal
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Description copied from interface: Terminal
    
    Closes the terminal.
    
    Specified by:
    
    close in interface Terminal
    
    Throws:
    
    IOException

Class TerminalImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLEAR_SCREEN

CURSOR_OFF

CURSOR_ON

MOVE

AUTO_WRAP_OFF

AUTO_WRAP_ON

Constructor Detail

TerminalImpl

TerminalImpl

Method Detail

getRows

getColumns

resize

setCursor

clear

get

get

get

put

put

put

put

put

put

put

put

put

put

put

put

flush

move

close