Package squidpony

Class ColoredStringList<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<IColoredString<T>>

squidpony.ColoredStringList<T>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<IColoredString<T>>, Collection<IColoredString<T>>, List<IColoredString<T>>, RandomAccess

public class ColoredStringList<T>
extends ArrayList<IColoredString<T>>

An helper class for code that deals with lists of IColoredStrings. It does nothing smart, its only purpose is to save you some typing for frequent calls. It is particularly useful when feeding large pieces of text to classes like TextPanel in the display module.

Author:

smelC

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ColoredStringList()
ColoredStringList(int expectedSize)

Method Summary

Modifier and Type	Method	Description
void	addAllText(Collection<? extends IColoredString<T>> texts)	Contrary to Collection.addAll(Collection), this method appends text to the current text, without inserting new lines.
void	addColoredText(String text, T c)	Appends colored text to this.
void	addColoredTextOnNewLine(String text, T color)	Appends colored text to this.
void	addEmptyLine()	Jumps a line.
void	addOnNewLine(Collection<? extends IColoredString<T>> texts)	Adds texts to this, starting a new line for the first one.
void	addText(String text)	Appends text to this, without specifying its color.
void	addText(IColoredString<T> text)	Appends text to this.
void	addTextOnNewLine(String text)	Appends text to this, on a new line; without specifying its color.
void	addTextOnNewLine(IColoredString<T> text)
static <T> ColoredStringList<T>	create()
static <T> ColoredStringList<T>	create(int expectedSize)
void	replaceColor(T old, T new_)	Changes a color in members of this.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

ColoredStringList

public ColoredStringList()

ColoredStringList

public ColoredStringList(int expectedSize)

Method Details

create

public static <T> ColoredStringList<T> create()

Returns:

A fresh empty instance.

create

public static <T> ColoredStringList<T> create(int expectedSize)

Parameters:

expectedSize -

Returns:

A fresh empty instance.

addText

public void addText(String text)

Appends text to this, without specifying its color.

Parameters:

text - the text to append

addText

public void addText(IColoredString<T> text)

Appends text to this.

Parameters:

text - the text to append

addColoredText

public void addColoredText(String text, T c)

Appends colored text to this.

Parameters:

text - the text to append

addTextOnNewLine

public void addTextOnNewLine(String text)

Appends text to this, on a new line; without specifying its color.

Parameters:

text - the text to append

addTextOnNewLine

public void addTextOnNewLine(IColoredString<T> text)

addColoredTextOnNewLine

public void addColoredTextOnNewLine(String text, T color)

Appends colored text to this.

Parameters:

text - the text to append

addOnNewLine

public void addOnNewLine(Collection<? extends IColoredString<T>> texts)

Adds texts to this, starting a new line for the first one.

Parameters:

texts - the Collection of objects extending IColoredString to append

addAllText

public void addAllText(Collection<? extends IColoredString<T>> texts)

Contrary to Collection.addAll(Collection), this method appends text to the current text, without inserting new lines.

Parameters:

texts - the Collection of objects extending IColoredString to append

addEmptyLine

public void addEmptyLine()

Jumps a line.

replaceColor

public void replaceColor(T old, T new_)

Changes a color in members of this.

Parameters:

old - The color to replace. Can be null.