ReadlineReader (The Java-Readline Library)

java.lang.Object
- java.io.Reader
- - org.gnu.readline.ReadlineReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable
```
public class ReadlineReader
extends Reader
```
A Reader wrapper for the Readline classes. This seems to work fine in conjunction with such classes as BufferedReader, but it hasn't been tested well enough to see if this will work well in all cases. This was implemented to make it easier to supplant Readline's functionality [shrug] anywhere and everywhere, but specifically in BeanShell.

Version:

$Revision: 1.2 $

Author:

Shane Celis

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_PROMPT
- Fields inherited from class java.io.Reader
  lock

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_PROMPT`

Constructor Summary

Constructors
Constructor and Description
`ReadlineReader(File history, ReadlineLibrary lib)` Constructs a ReadlineReader object with an associated history file.
`ReadlineReader(ReadlineLibrary lib)` Constructs a ReadlineReader object with the default prompt.
`ReadlineReader(String prompt, File history, ReadlineLibrary lib)` Constructs a ReadlineReader object with an associated history file and prompt.
`ReadlineReader(String prompt, ReadlineLibrary lib)` Constructs a ReadlineReader object with the given prompt.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Nullifies all buffers and writes history file if one was given at construction time.
`String`	`getPrompt()` Returns the current prompt.
`static void`	`main(String[] args)`
`int`	`read(char[] cbuf, int off, int len)` Reads what's given from `readline()` into a buffer.
`void`	`setPrompt(String prompt)` Sets the prompt to the given value.

Methods inherited from class java.io.Reader
mark, markSupported, read, read, read, ready, reset, skip

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

- Field Detail
  - DEFAULT_PROMPT
```
public static final String DEFAULT_PROMPT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReadlineReader
```
public ReadlineReader(String prompt,
                      ReadlineLibrary lib)
```
    Constructs a ReadlineReader object with the given prompt.
  - ReadlineReader
```
public ReadlineReader(ReadlineLibrary lib)
```
    Constructs a ReadlineReader object with the default prompt.
  - ReadlineReader
```
public ReadlineReader(File history,
                      ReadlineLibrary lib)
               throws IOException
```
    Constructs a ReadlineReader object with an associated history file.
    
    Throws:
    
    IOException
  - ReadlineReader
```
public ReadlineReader(String prompt,
                      File history,
                      ReadlineLibrary lib)
               throws IOException
```
    Constructs a ReadlineReader object with an associated history file and prompt.
    
    Throws:
    
    IOException
- Method Detail
  - getPrompt
```
public String getPrompt()
```
    Returns the current prompt.
  - setPrompt
```
public void setPrompt(String prompt)
```
    Sets the prompt to the given value.
  - read
```
public int read(char[] cbuf,
                int off,
                int len)
         throws IOException
```
    Reads what's given from readline() into a buffer. When that buffer is emptied, readline() is called again to replenish that buffer. This seems to work fine in conjunction with such classes as BufferedReader, but it hasn't been tested well enough to see if this will work well in all cases.
    
    Specified by:
    
    read in class Reader
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Nullifies all buffers and writes history file if one was given at construction time.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class Reader
    
    Throws:
    
    IOException
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception

Class ReadlineReader

Field Summary

Fields inherited from class java.io.Reader

Constructor Summary

Method Summary

Methods inherited from class java.io.Reader

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROMPT

Constructor Detail

ReadlineReader

ReadlineReader

ReadlineReader

ReadlineReader

Method Detail

getPrompt

setPrompt

read

close

main