org.spongepowered.api.text.transform

Class SimpleTextFormatter

java.lang.Object

org.spongepowered.api.text.transform.SimpleTextFormatter

All Implemented Interfaces:

Iterable<SimpleTextTemplateApplier>, TextElement, TextRepresentable, TextFormatter<SimpleTextTemplateApplier>

public class SimpleTextFormatter
extends Object
implements TextFormatter<SimpleTextTemplateApplier>

A basic implementation of TextFormatter backed by an ArrayList.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<SimpleTextTemplateApplier>	parts

Constructor Summary

Constructors

Constructor and Description
SimpleTextFormatter() Constructs an empty text formatter.
SimpleTextFormatter(int initialSize) Constructs a new SimpleTextFormatter with the specified amount of initial TextTemplateAppliers.

Method Summary

Modifier and Type	Method and Description
boolean	add(Collection<SimpleTextTemplateApplier> elements) Adds the specified elements to the end of this formatter.
boolean	add(SimpleTextTemplateApplier element) Adds the specified element to the end of this formatter.
void	clear() Clears all elements from this formatter.
boolean	contains(SimpleTextTemplateApplier element) Returns true if the specified element is in the formatter.
SimpleTextTemplateApplier	get(int i) Returns the element at the specified index.
ImmutableList<SimpleTextTemplateApplier>	getAll() Returns an ImmutableList of this formatter's elements.
void	insert(int i, Collection<SimpleTextTemplateApplier> elements) Inserts the specified elements at the specified index within the formatter.
void	insert(int i, SimpleTextTemplateApplier element) Inserts the specified element at the specified index within the formatter.
boolean	isEmpty() Returns true if the formatter contains no elements.
boolean	remove(Collection<SimpleTextTemplateApplier> elements) Removes the specified elements from the formatter.
boolean	remove(SimpleTextTemplateApplier element) Removes the specified element from the formatter.
boolean	retain(Collection<SimpleTextTemplateApplier> elements) Removes all elements from the formatter except for these specified elements.
SimpleTextTemplateApplier	set(int i, SimpleTextTemplateApplier element) Replaces the element previously at the specified index with the specified element.
int	size() Returns the amount of elements in this formatter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.text.transform.TextFormatter

add, add, first, firstAfter, forEach, forEachAfter, format, insert, insert, iterator, remove, remove, retain, retain, toText

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

parts

protected final List<SimpleTextTemplateApplier> parts

Constructor Detail

SimpleTextFormatter

public SimpleTextFormatter(int initialSize)

Constructs a new SimpleTextFormatter with the specified amount of initial TextTemplateAppliers.

Parameters:

initialSize - Initial amount of Parts

SimpleTextFormatter

public SimpleTextFormatter()

Constructs an empty text formatter.

Method Detail

getAll

public ImmutableList<SimpleTextTemplateApplier> getAll()

Description copied from interface: TextFormatter

Returns an ImmutableList of this formatter's elements.

Specified by:

getAll in interface TextFormatter<SimpleTextTemplateApplier>

Returns:

All elements

get

public SimpleTextTemplateApplier get(int i)

Description copied from interface: TextFormatter

Returns the element at the specified index.

Specified by:

get in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

i - Index to retrieve from

Returns:

Element at index

set

public SimpleTextTemplateApplier set(int i,
                                     SimpleTextTemplateApplier element)

Description copied from interface: TextFormatter

Replaces the element previously at the specified index with the specified element.

Specified by:

set in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

i - Index to replace

element - Element to replace with

Returns:

Element previously at index

size

public int size()

Description copied from interface: TextFormatter

Returns the amount of elements in this formatter.

Specified by:

size in interface TextFormatter<SimpleTextTemplateApplier>

Returns:

Amount of elements

isEmpty

public boolean isEmpty()

Description copied from interface: TextFormatter

Returns true if the formatter contains no elements.

Specified by:

isEmpty in interface TextFormatter<SimpleTextTemplateApplier>

Returns:

True if contains no elements

contains

public boolean contains(SimpleTextTemplateApplier element)

Description copied from interface: TextFormatter

Returns true if the specified element is in the formatter.

Specified by:

contains in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

element - Element to check

Returns:

True if in formatter

clear

public void clear()

Description copied from interface: TextFormatter

Clears all elements from this formatter.

Specified by:

clear in interface TextFormatter<SimpleTextTemplateApplier>

add

public boolean add(SimpleTextTemplateApplier element)

Description copied from interface: TextFormatter

Adds the specified element to the end of this formatter.

Specified by:

add in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

element - Element to add

Returns:

True if the formatter changed as a result of the call

add

public boolean add(Collection<SimpleTextTemplateApplier> elements)

Description copied from interface: TextFormatter

Adds the specified elements to the end of this formatter.

Specified by:

add in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

elements - Elements to add

Returns:

True if the formatter changed as a result of the call

insert

public void insert(int i,
                   SimpleTextTemplateApplier element)

Description copied from interface: TextFormatter

Inserts the specified element at the specified index within the formatter.

Specified by:

insert in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

i - Index to insert at

element - Element to insert

insert

public void insert(int i,
                   Collection<SimpleTextTemplateApplier> elements)

Description copied from interface: TextFormatter

Inserts the specified elements at the specified index within the formatter.

Specified by:

insert in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

i - Index to insert at

elements - Elements to insert

remove

public boolean remove(SimpleTextTemplateApplier element)

Description copied from interface: TextFormatter

Removes the specified element from the formatter.

Specified by:

remove in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

element - Element to remove

Returns:

True if this formatter contained the Element

remove

public boolean remove(Collection<SimpleTextTemplateApplier> elements)

Description copied from interface: TextFormatter

Removes the specified elements from the formatter.

Specified by:

remove in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

elements - Elements to remove

Returns:

True if the formatter changed as a result of this call

retain

public boolean retain(Collection<SimpleTextTemplateApplier> elements)

Description copied from interface: TextFormatter

Removes all elements from the formatter except for these specified elements.

Specified by:

retain in interface TextFormatter<SimpleTextTemplateApplier>

Parameters:

elements - Elements to retain

Returns:

True if the formatter changed as a result of this call