jline

Class History

java.lang.Object

jline.History

public class History
extends Object

A command history buffer.

Author:

Marc Prud'hommeaux

Constructor Summary

Constructors

Constructor and Description
History() Construstor: initialize a blank history.
History(File historyFile) Construstor: initialize History object the the specified File for storage.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToHistory(String buffer) Add the specified buffer to the end of the history.
void	clear() Clear the history buffer
String	current() Return the content of the current buffer.
void	flushBuffer() Flush the entire history buffer to the output PrintWriter.
int	getCurrentIndex() Returns the current history index.
String	getHistory(int index) Get the history string for the given index.
List	getHistoryList() Returns an immutable list of the history buffer.
int	getMaxSize() Get the maximum size that the history buffer will store.
PrintWriter	getOutput() Returns the PrintWriter that is used to store history elements.
void	load(InputStream in) Load the history buffer from the specified InputStream.
void	load(Reader reader) Load the history buffer from the specified Reader.
void	moveToEnd() Move to the end of the history buffer.
boolean	moveToFirstEntry() Moves the history index to the first entry.
boolean	moveToLastEntry() This moves the history to the last entry.
boolean	next() Move the pointer to the next element in the buffer.
boolean	previous() Move the pointer to the previous element in the buffer.
int	searchBackwards(String s) Search backwards in history from the current position.
int	searchBackwards(String searchTerm, int startIndex) Search backward in history from a given position.
void	setCurrentIndex(int index) Set current index to given number.
void	setHistoryFile(File historyFile)
void	setMaxSize(int maxSize) Set the maximum size that the history buffer will store.
void	setOutput(PrintWriter output) The output to which all history elements will be written (or null of history is not saved to a buffer).
int	size()
String	toString() Returns the standard AbstractCollection.toString() representation of the history list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

History

public History()

Construstor: initialize a blank history.

History

public History(File historyFile)
        throws IOException

Construstor: initialize History object the the specified File for storage.

Throws:

IOException

Method Detail

setHistoryFile

public void setHistoryFile(File historyFile)
                    throws IOException

Throws:

IOException

load

public void load(InputStream in)
          throws IOException

Load the history buffer from the specified InputStream.

Throws:

IOException

load

public void load(Reader reader)
          throws IOException

Load the history buffer from the specified Reader.

Throws:

IOException

size

public int size()

clear

public void clear()

Clear the history buffer

addToHistory

public void addToHistory(String buffer)

Add the specified buffer to the end of the history. The pointer is set to the end of the history buffer.

flushBuffer

public void flushBuffer()
                 throws IOException

Flush the entire history buffer to the output PrintWriter.

Throws:

IOException

moveToLastEntry

public boolean moveToLastEntry()

This moves the history to the last entry. This entry is one position before the moveToEnd() position.

Returns:

Returns false if there were no history entries or the history index was already at the last entry.

moveToEnd

public void moveToEnd()

Move to the end of the history buffer. This will be a blank entry, after all of the other entries.

setMaxSize

public void setMaxSize(int maxSize)

Set the maximum size that the history buffer will store.

getMaxSize

public int getMaxSize()

Get the maximum size that the history buffer will store.

setOutput

public void setOutput(PrintWriter output)

The output to which all history elements will be written (or null of history is not saved to a buffer).

getOutput

public PrintWriter getOutput()

Returns the PrintWriter that is used to store history elements.

getCurrentIndex

public int getCurrentIndex()

Returns the current history index.

current

public String current()

Return the content of the current buffer.

previous

public boolean previous()

Move the pointer to the previous element in the buffer.

Returns:

true if we successfully went to the previous element

next

public boolean next()

Move the pointer to the next element in the buffer.

Returns:

true if we successfully went to the next element

getHistoryList

public List getHistoryList()

Returns an immutable list of the history buffer.

toString

public String toString()

Returns the standard AbstractCollection.toString() representation of the history list.

Overrides:

toString in class Object

moveToFirstEntry

public boolean moveToFirstEntry()

Moves the history index to the first entry.

Returns:

Return false if there are no entries in the history or if the history is already at the beginning.

searchBackwards

public int searchBackwards(String searchTerm,
                  int startIndex)

Search backward in history from a given position.

Parameters:

searchTerm - substring to search for.

startIndex - the index from which on to search

Returns:

index where this substring has been found, or -1 else.

searchBackwards

public int searchBackwards(String s)

Search backwards in history from the current position.

Parameters:

searchTerm - substring to search for.

Returns:

index where the substring has been found, or -1 else.

getHistory

public String getHistory(int index)

Get the history string for the given index.

Parameters:

index -

Returns:

setCurrentIndex

public void setCurrentIndex(int index)

Set current index to given number.

Parameters:

index -