org.jline.reader

Interface History

All Superinterfaces:

Iterable<History.Entry>

All Known Implementing Classes:

DefaultHistory

public interface History
extends Iterable<History.Entry>

Console history.

Since:

2.3

Author:

Marc Prud'hommeaux, Jason Dillon

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	History.Entry

Method Summary

Modifier and Type	Method and Description
void	add(Instant time, String line)
default void	add(String line)
void	attach(LineReader reader) Initialize the history for the given reader.
String	current() Return the content of the current buffer.
int	first()
String	get(int index)
int	index()
default boolean	isEmpty()
default ListIterator<History.Entry>	iterator()
ListIterator<History.Entry>	iterator(int index)
int	last()
void	load() Load history.
boolean	moveTo(int index) Move to the specified index in the history
void	moveToEnd() Move to the end of the history buffer.
boolean	moveToFirst() Moves the history index to the first entry.
boolean	moveToLast() 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.
void	purge() Purge history.
void	save() Save history.
int	size()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

attach

void attach(LineReader reader)

Initialize the history for the given reader.

load

void load()
   throws IOException

Load history.

Throws:

IOException

save

void save()
   throws IOException

Save history.

Throws:

IOException

purge

void purge()
    throws IOException

Purge history.

Throws:

IOException

size

int size()

isEmpty

default boolean isEmpty()

index

int index()

first

int first()

last

int last()

get

String get(int index)

add

default void add(String line)

add

void add(Instant time,
         String line)

iterator

ListIterator<History.Entry> iterator(int index)

iterator

default ListIterator<History.Entry> iterator()

Specified by:

iterator in interface Iterable<History.Entry>

current

String current()

Return the content of the current buffer.

previous

boolean previous()

Move the pointer to the previous element in the buffer.

Returns:

true if we successfully went to the previous element

next

boolean next()

Move the pointer to the next element in the buffer.

Returns:

true if we successfully went to the next element

moveToFirst

boolean moveToFirst()

Moves the history index to the first entry.

Returns:

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

moveToLast

boolean moveToLast()

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 iterator or the history index was already at the last entry.

moveTo

boolean moveTo(int index)

Move to the specified index in the history

moveToEnd

void moveToEnd()

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