Module net.morimekta.terminal

Package net.morimekta.terminal

Class LineBuffer

java.lang.Object

net.morimekta.terminal.LineBuffer

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>, Collection<String>, List<String>, RandomAccess

public class LineBuffer
extends Object
implements List<String>, RandomAccess, Closeable

Class that holds a set of lines, that are printed to the terminal, and methods to dynamically update those buffer. It will keep the cursor at the bottom line (end of printed line) for easy continuation.

The class acts as a wrapper around a Terminal instance, and makes sure that a list of lines can be updated and printed properly to the terminal in the most efficient order.

Example uses are for showing a list of ProgressLine'es, or handling the internals of a Selection.

Constructor Summary

Constructors

Constructor	Description
LineBuffer(PrintStream writer)	Create a LineBuffer instance.
LineBuffer(PrintStream writer, int initialCapacity)	Create a LineBuffer instance.

Method Summary

Modifier and Type	Method	Description
void	add(int i, String line)
boolean	add(String line)
boolean	addAll(int i, Collection<? extends String> collection)
boolean	addAll(Collection<? extends String> collection)
List<String>	asList()
void	clear()
void	clearLast(int N)	Clear the last N lines, and move the cursor to the end of the last remaining line.
void	close()
boolean	contains(Object o)
boolean	containsAll(Collection<?> collection)
boolean	equals(Object obj)
String	get(int i)
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<String>	iterator()
int	lastIndexOf(Object o)
ListIterator<String>	listIterator()
ListIterator<String>	listIterator(int i)
String	remove(int i)
boolean	remove(Object o)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
List<String>	reversed()	Compatibility method for java-21.
String	set(int i, String line)
boolean	setAll(int startOffset, Collection<String> lines)	Set a number of lines starting at given offset.
int	size()
List<String>	subList(int start, int end)
Object[]	toArray()
<T> T[]	toArray(T[] ts)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Constructor Detail

LineBuffer

public LineBuffer(PrintStream writer)

Create a LineBuffer instance.

Parameters:

writer - The terminal to wrap.

LineBuffer

public LineBuffer(PrintStream writer,
                  int initialCapacity)

Create a LineBuffer instance.

Parameters:

writer - The terminal to wrap.

initialCapacity - Initial capacity of contained array list.

Method Detail

asList

public List<String> asList()

Returns:

Content of line buffer as a list.

clearLast

public void clearLast(int N)

Clear the last N lines, and move the cursor to the end of the last remaining line.

Parameters:

N - Number of lines to clear.

setAll

public boolean setAll(int startOffset,
                      Collection<String> lines)

Set a number of lines starting at given offset.

Parameters:

startOffset - The start offset.

lines - The lines to set.

Returns:

If any lines were set.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

clear

public void clear()

Specified by:

clear in interface Collection<String>

Specified by:

clear in interface List<String>

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface List<String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<String>

Specified by:

isEmpty in interface List<String>

get

public String get(int i)

Specified by:

get in interface List<String>

add

public boolean add(String line)

Specified by:

add in interface Collection<String>

Specified by:

add in interface List<String>

add

public void add(int i,
                String line)

Specified by:

add in interface List<String>

addAll

public boolean addAll(int i,
                      Collection<? extends String> collection)

Specified by:

addAll in interface List<String>

set

public String set(int i,
                  String line)

Specified by:

set in interface List<String>

remove

public String remove(int i)

Specified by:

remove in interface List<String>

addAll

public boolean addAll(Collection<? extends String> collection)

Specified by:

addAll in interface Collection<String>

Specified by:

addAll in interface List<String>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<String>

Specified by:

remove in interface List<String>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<String>

Specified by:

removeAll in interface List<String>

retainAll

public boolean retainAll(Collection<?> collection)

Specified by:

retainAll in interface Collection<String>

Specified by:

retainAll in interface List<String>

subList

public List<String> subList(int start,
                            int end)

Specified by:

subList in interface List<String>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<String>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<String>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<String>

Specified by:

contains in interface List<String>

containsAll

public boolean containsAll(Collection<?> collection)

Specified by:

containsAll in interface Collection<String>

Specified by:

containsAll in interface List<String>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface List<String>

toArray

public <T> T[] toArray(T[] ts)

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface List<String>

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface List<String>

listIterator

public ListIterator<String> listIterator()

Specified by:

listIterator in interface List<String>

listIterator

public ListIterator<String> listIterator(int i)

Specified by:

listIterator in interface List<String>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<String>

Specified by:

equals in interface List<String>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<String>

Specified by:

hashCode in interface List<String>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

reversed

public List<String> reversed()

Compatibility method for java-21.

Returns:

The list of entries, reversed.