Modifier and Type	Class and Description
protected static class	DefaultHistory.EntryImpl
private static class	DefaultHistory.HistoryFileData

Modifier and Type	Field and Description
public static final int	DEFAULT_HISTORY_FILE_SIZE
public static final int	DEFAULT_HISTORY_SIZE
private Map<String, DefaultHistory.HistoryFileData>	historyFiles
private int	index
private final LinkedList<History.Entry>	items
private int	offset
private LineReader	reader

Access	Constructor and Description
public	DefaultHistory()
public	DefaultHistory(LineReader reader)

Method Summary

Modifier and Type	Method and Description
public void	add(Instant time, String line) Implements jdk.internal.org.jline.reader.History.add.
protected void	addHistoryLine(Path path, String line)
protected void	addHistoryLine(Path path, String line, boolean checkDuplicates)
public void	append(Path file, boolean incremental) Implements jdk.internal.org.jline.reader.History.append. Append history to the file.
public void	attach(LineReader reader) Implements jdk.internal.org.jline.reader.History.attach. Initialize the history for the given reader.
protected DefaultHistory.EntryImpl	Returns: entry object createEntry(int index of history entry index, Instant entry creation time time, String the entry text line) Create a history entry.
public String	current() Implements jdk.internal.org.jline.reader.History.current. Return the content of the current buffer.
private String	doHistoryFileDataKey(Path path)
pack-priv static List<History.Entry>	doTrimHistory(List<History.Entry> allItems, int max)
private static String	escape(String s)
public int	first() Implements jdk.internal.org.jline.reader.History.first.
private String	format(History.Entry entry)
public String	get(final int index) Implements jdk.internal.org.jline.reader.History.get.
private int	getEntriesInFile(Path path)
private DefaultHistory.HistoryFileData	getHistoryFileData(Path path)
private int	getLastLoaded(Path path)
private Path	getPath()
private void	incEntriesInFile(Path path, int amount)
public int	index() Implements jdk.internal.org.jline.reader.History.index.
protected void	internalAdd(Instant time, String line)
protected void	internalAdd(Instant time, String line, boolean checkDuplicates)
private void	internalClear()
private void	internalWrite(Path path, int from)
public boolean	isEmpty() Overrides default jdk.internal.org.jline.reader.History.isEmpty.
private boolean	isLineReaderHistory(Path path)
public ListIterator<History.Entry>	iterator(int index) Implements jdk.internal.org.jline.reader.History.iterator.
public int	last() Implements jdk.internal.org.jline.reader.History.last.
public void	load() Implements jdk.internal.org.jline.reader.History.load. Load history.
protected boolean	matchPatterns(String patterns, String line)
private void	maybeResize()
public boolean	moveTo(int index) Implements jdk.internal.org.jline.reader.History.moveTo. Move to the specified index in the history
public void	moveToEnd() Implements jdk.internal.org.jline.reader.History.moveToEnd. Move to the end of the history buffer.
public boolean	Returns: Return false if there are no iterator in the history or if the history is already at the beginning. moveToFirst() Implements jdk.internal.org.jline.reader.History.moveToFirst. Moves the history index to the first entry.
public boolean	Returns: Returns false if there were no history iterator or the history index was already at the last entry. moveToLast() Implements jdk.internal.org.jline.reader.History.moveToLast. This moves the history to the last entry.
public boolean	Returns: true if we successfully went to the next element next() Implements jdk.internal.org.jline.reader.History.next. Move the pointer to the next element in the buffer.
public boolean	Returns: true if we successfully went to the previous element previous() Implements jdk.internal.org.jline.reader.History.previous. Move the pointer to the previous element in the buffer.
public void	purge() Implements jdk.internal.org.jline.reader.History.purge. Purge history.
public void	read(Path file, boolean checkDuplicates) Implements jdk.internal.org.jline.reader.History.read. Read history from the file.
public void	resetIndex() Implements jdk.internal.org.jline.reader.History.resetIndex. Reset index after remove
public void	save() Implements jdk.internal.org.jline.reader.History.save. Save history.
private void	setEntriesInFile(Path path, int entriesInFile)
private void	setHistoryFileData(Path path, DefaultHistory.HistoryFileData historyFileData)
private void	setLastLoaded(Path path, int lastloaded)
public int	size() Implements jdk.internal.org.jline.reader.History.size.
public Spliterator<History.Entry>	spliterator() Overrides default java.lang.Iterable.spliterator. Creates a `Spliterator` over the elements described by this `Iterable`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected void	trimHistory(Path path, int max)
pack-priv static String	unescape(String s)
public void	write(Path file, boolean incremental) Implements jdk.internal.org.jline.reader.History.write. Write history to the file.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

DEFAULT_HISTORY_FILE_SIZE	back to summary
public static final int DEFAULT_HISTORY_FILE_SIZE

DEFAULT_HISTORY_SIZE	back to summary
public static final int DEFAULT_HISTORY_SIZE

historyFiles	back to summary
private Map<String, DefaultHistory.HistoryFileData> historyFiles

index	back to summary
private int index

items	back to summary
private final LinkedList<History.Entry> items

offset	back to summary
private int offset

reader	back to summary
private LineReader reader

Constructor Detail

DefaultHistory	back to summary
public DefaultHistory()

DefaultHistory	back to summary
public DefaultHistory(LineReader reader) Annotations @SuppressWarnings:this-escape

Method Detail

add	back to summary
public void add(Instant time, String line) Implements jdk.internal.org.jline.reader.History.add. Annotations @Override

add

back to summary

public void add(Instant time, String line)

Implements jdk.internal.org.jline.reader.History.add.

Annotations

@Override

addHistoryLine	back to summary
protected void addHistoryLine(Path path, String line)

addHistoryLine	back to summary
protected void addHistoryLine(Path path, String line, boolean checkDuplicates)

append	back to summary
public void append(Path file, boolean incremental) throws IOException Implements jdk.internal.org.jline.reader.History.append. Doc from jdk.internal.org.jline.reader.History.append. Append history to the file. If incremental only the events that are new since the last incremental operation to the file are added. Annotations @Override Exceptions IOException: if a problem occurs

append

back to summary

public void append(Path file, boolean incremental) throws IOException

Implements jdk.internal.org.jline.reader.History.append.

Doc from jdk.internal.org.jline.reader.History.append.

Append history to the file. If incremental only the events that are new since the last incremental operation to the file are added.

Annotations

@Override

Exceptions

IOException:: if a problem occurs

attach	back to summary
public void attach(LineReader reader) Implements jdk.internal.org.jline.reader.History.attach. Doc from jdk.internal.org.jline.reader.History.attach. Initialize the history for the given reader. Annotations @Override

attach

back to summary

public void attach(LineReader reader)

Implements jdk.internal.org.jline.reader.History.attach.

Doc from jdk.internal.org.jline.reader.History.attach.

Initialize the history for the given reader.

Annotations

@Override

createEntry	back to summary
protected DefaultHistory.EntryImpl createEntry(int index, Instant time, String line) Create a history entry. Subclasses may override to use their own entry implementations. Parameters index:int index of history entry time:Instant entry creation time line:String the entry text Returns:DefaultHistory.EntryImpl entry object

createEntry

back to summary

protected DefaultHistory.EntryImpl createEntry(int index, Instant time, String line)

Create a history entry. Subclasses may override to use their own entry implementations.

Parameters

index:int: index of history entry
time:Instant: entry creation time
line:String: the entry text

Returns:DefaultHistory.EntryImpl

entry object

current	back to summary
public String current() Implements jdk.internal.org.jline.reader.History.current. Return the content of the current buffer.

current

back to summary

public String current()

Implements jdk.internal.org.jline.reader.History.current.

Return the content of the current buffer.

doHistoryFileDataKey	back to summary
private String doHistoryFileDataKey(Path path)

doTrimHistory	back to summary
pack-priv static List<History.Entry> doTrimHistory(List<History.Entry> allItems, int max)

escape	back to summary
private static String escape(String s)

first	back to summary
public int first() Implements jdk.internal.org.jline.reader.History.first.

format	back to summary
private String format(History.Entry entry)

get	back to summary
public String get(final int index) Implements jdk.internal.org.jline.reader.History.get.

getEntriesInFile	back to summary
private int getEntriesInFile(Path path)

getHistoryFileData	back to summary
private DefaultHistory.HistoryFileData getHistoryFileData(Path path)

getLastLoaded	back to summary
private int getLastLoaded(Path path)

getPath	back to summary
private Path getPath()

incEntriesInFile	back to summary
private void incEntriesInFile(Path path, int amount)

index	back to summary
public int index() Implements jdk.internal.org.jline.reader.History.index.

internalAdd	back to summary
protected void internalAdd(Instant time, String line)

internalAdd	back to summary
protected void internalAdd(Instant time, String line, boolean checkDuplicates)

internalClear	back to summary
private void internalClear()

internalWrite	back to summary
private void internalWrite(Path path, int from) throws IOException

isEmpty	back to summary
public boolean isEmpty() Overrides default jdk.internal.org.jline.reader.History.isEmpty.

isLineReaderHistory	back to summary
private boolean isLineReaderHistory(Path path) throws IOException

iterator	back to summary
public ListIterator<History.Entry> iterator(int index) Implements jdk.internal.org.jline.reader.History.iterator.

last	back to summary
public int last() Implements jdk.internal.org.jline.reader.History.last.

load	back to summary
public void load() throws IOException Implements jdk.internal.org.jline.reader.History.load. Doc from jdk.internal.org.jline.reader.History.load. Load history. Annotations @Override Exceptions IOException: if a problem occurs

load

back to summary

public void load() throws IOException

Implements jdk.internal.org.jline.reader.History.load.

Doc from jdk.internal.org.jline.reader.History.load.

Load history.

Annotations

@Override

Exceptions

IOException:: if a problem occurs

matchPatterns	back to summary
protected boolean matchPatterns(String patterns, String line)

maybeResize	back to summary
private void maybeResize()

moveTo	back to summary
public boolean moveTo(int index) Implements jdk.internal.org.jline.reader.History.moveTo. Move to the specified index in the history

moveTo

back to summary

public boolean moveTo(int index)

Implements jdk.internal.org.jline.reader.History.moveTo.

Move to the specified index in the history

moveToEnd	back to summary
public void moveToEnd() Implements jdk.internal.org.jline.reader.History.moveToEnd. Move to the end of the history buffer. This will be a blank entry, after all of the other iterator.

moveToEnd

back to summary

public void moveToEnd()

Implements jdk.internal.org.jline.reader.History.moveToEnd.

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

moveToFirst	back to summary
public boolean moveToFirst() Implements jdk.internal.org.jline.reader.History.moveToFirst. Moves the history index to the first entry. Returns:boolean Return false if there are no iterator in the history or if the history is already at the beginning.

moveToFirst

back to summary

public boolean moveToFirst()

Implements jdk.internal.org.jline.reader.History.moveToFirst.

Moves the history index to the first entry.

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

moveToLast	back to summary
public boolean moveToLast() Implements jdk.internal.org.jline.reader.History.moveToLast. This moves the history to the last entry. This entry is one position before the moveToEnd() position. Returns:boolean Returns false if there were no history iterator or the history index was already at the last entry.

moveToLast

back to summary

public boolean moveToLast()

Implements jdk.internal.org.jline.reader.History.moveToLast.

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

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

next	back to summary
public boolean next() Implements jdk.internal.org.jline.reader.History.next. Move the pointer to the next element in the buffer. Returns:boolean true if we successfully went to the next element

back to summary

public boolean next()

Implements jdk.internal.org.jline.reader.History.next.

Move the pointer to the next element in the buffer.

Returns:boolean: true if we successfully went to the next element

previous	back to summary
public boolean previous() Implements jdk.internal.org.jline.reader.History.previous. Move the pointer to the previous element in the buffer. Returns:boolean true if we successfully went to the previous element

back to summary

public boolean previous()

Implements jdk.internal.org.jline.reader.History.previous.

Move the pointer to the previous element in the buffer.

Returns:boolean: true if we successfully went to the previous element

purge	back to summary
public void purge() throws IOException Implements jdk.internal.org.jline.reader.History.purge. Doc from jdk.internal.org.jline.reader.History.purge. Purge history. Annotations @Override Exceptions IOException: if a problem occurs

purge

back to summary

public void purge() throws IOException

Implements jdk.internal.org.jline.reader.History.purge.

Doc from jdk.internal.org.jline.reader.History.purge.

Purge history.

Annotations

@Override

Exceptions

IOException:: if a problem occurs

read back to summary

public void read(Path file, boolean checkDuplicates) throws IOException

Implements jdk.internal.org.jline.reader.History.read.

Doc from jdk.internal.org.jline.reader.History.read.

Read history from the file. If checkDuplicates is true only the events that are not contained within the internal list are added.

Annotations

@Override

Exceptions

IOException:: if a problem occurs

resetIndex

back to summary

public void resetIndex()

Implements jdk.internal.org.jline.reader.History.resetIndex.

Doc from jdk.internal.org.jline.reader.History.resetIndex.

Reset index after remove

save

back to summary

public void save() throws IOException

Implements jdk.internal.org.jline.reader.History.save.

Doc from jdk.internal.org.jline.reader.History.save.

Save history.

Annotations

@Override

Exceptions

IOException:: if a problem occurs

setEntriesInFile	back to summary
private void setEntriesInFile(Path path, int entriesInFile)

setHistoryFileData	back to summary
private void setHistoryFileData(Path path, DefaultHistory.HistoryFileData historyFileData)

setLastLoaded	back to summary
private void setLastLoaded(Path path, int lastloaded)

size	back to summary
public int size() Implements jdk.internal.org.jline.reader.History.size.

spliterator back to summary

public Spliterator<History.Entry> spliterator()

Overrides default java.lang.Iterable.spliterator.

Doc from java.lang.Iterable.spliterator.

Creates a Spliterator over the elements described by this Iterable.

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

trimHistory	back to summary
protected void trimHistory(Path path, int max) throws IOException

unescape	back to summary
pack-priv static String unescape(String s)

write

back to summary

public void write(Path file, boolean incremental) throws IOException

Implements jdk.internal.org.jline.reader.History.write.

Doc from jdk.internal.org.jline.reader.History.write.

Write history to the file. If incremental only the events that are new since the last incremental operation to the file are added.

Annotations

@Override

Exceptions

IOException:: if a problem occurs

jdk.internal.org.jline.reader.impl.history back to summary

protected Class DefaultHistory.EntryImpl

Class Inheritance

extends Object
implements Entry

java.lang.Object
jdk.internal.org.jline.reader.impl.history.DefaultHistory.EntryImpl

All Implemented Interfaces

jdk.internal.org.jline.reader.History.Entry

Field Summary

Modifier and Type	Field and Description
private final int	index
private final String	line
private final Instant	time

Constructor Summary

Access	Constructor and Description
public	EntryImpl(int index, Instant time, String line)

Method Summary

Modifier and Type	Method and Description
public int	index() Implements jdk.internal.org.jline.reader.History.Entry.index.
public String	line() Implements jdk.internal.org.jline.reader.History.Entry.line.
public Instant	time() Implements jdk.internal.org.jline.reader.History.Entry.time.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

index	back to summary
private final int index

line	back to summary
private final String line

time	back to summary
private final Instant time

Constructor Detail

EntryImpl	back to summary
public EntryImpl(int index, Instant time, String line)

Method Detail

index	back to summary
public int index() Implements jdk.internal.org.jline.reader.History.Entry.index.

line	back to summary
public String line() Implements jdk.internal.org.jline.reader.History.Entry.line.

time	back to summary
public Instant time() Implements jdk.internal.org.jline.reader.History.Entry.time.

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class DefaultHistory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class DefaultHistory.EntryImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultHistory.HistoryFileData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Access	Constructor and Description
public	HistoryFileData()
public	HistoryFileData(int lastLoaded, int entriesInFile)

Modifier and Type	Method and Description
public void	decLastLoaded()
public int	getEntriesInFile()
public int	getLastLoaded()
public void	incEntriesInFile(int amount)
public void	setEntriesInFile(int entriesInFile)
public void	setLastLoaded(int lastLoaded)