org.spongepowered.api.text.transform

Class FixedPartitionedTextFormatter

java.lang.Object

org.spongepowered.api.text.transform.FixedPartitionedTextFormatter

All Implemented Interfaces:

Iterable<SimpleTextFormatter>, TextElement, TextRepresentable, PartitionedTextFormatter<SimpleTextFormatter>, TextFormatter<SimpleTextFormatter>

Direct Known Subclasses:

MessageEvent.MessageFormatter

public class FixedPartitionedTextFormatter
extends Object
implements PartitionedTextFormatter<SimpleTextFormatter>

Implementation of PartitionedTextFormatter that has a fixed amount of partitions.

Constructor Summary

Constructors

Constructor and Description
FixedPartitionedTextFormatter() Creates a new FixedPartitionedTextFormatter with the provided size of partitions.
FixedPartitionedTextFormatter(int size) Creates a new FixedPartitionedTextFormatter with the provided size of partitions.

Method Summary

Modifier and Type	Method and Description
boolean	add(Collection<SimpleTextFormatter> elements) Adds the specified elements to the end of this formatter.
boolean	add(SimpleTextFormatter element) Adds the specified element to the end of this formatter.
void	clear() Clears each partition.
boolean	contains(SimpleTextFormatter element) Returns true if the specified element is in the formatter.
SimpleTextFormatter	get(int i) Returns the element at the specified index.
ImmutableList<SimpleTextFormatter>	getAll() Returns an ImmutableList of this formatter's elements.
void	insert(int i, Collection<SimpleTextFormatter> elements) Inserts the specified elements at the specified index within the formatter.
void	insert(int i, SimpleTextFormatter element) Inserts the specified element at the specified index within the formatter.
boolean	isEmpty() Returns true if each partition is empty.
boolean	remove(Collection<SimpleTextFormatter> elements) Removes the specified elements from the formatter.
boolean	remove(SimpleTextFormatter element) Removes the specified element from the formatter.
boolean	retain(Collection<SimpleTextFormatter> elements) Removes all elements from the formatter except for these specified elements.
SimpleTextFormatter	set(int i, SimpleTextFormatter 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

Constructor Detail

FixedPartitionedTextFormatter

public FixedPartitionedTextFormatter(int size)

Creates a new FixedPartitionedTextFormatter with the provided size of partitions.

Parameters:

size - The size of partitions

FixedPartitionedTextFormatter

public FixedPartitionedTextFormatter()

Creates a new FixedPartitionedTextFormatter with the provided size of partitions.

Method Detail

getAll

public ImmutableList<SimpleTextFormatter> getAll()

Description copied from interface: TextFormatter

Returns an ImmutableList of this formatter's elements.

Specified by:

getAll in interface TextFormatter<SimpleTextFormatter>

Returns:

All elements

get

public SimpleTextFormatter get(int i)

Description copied from interface: TextFormatter

Returns the element at the specified index.

Specified by:

get in interface TextFormatter<SimpleTextFormatter>

Parameters:

i - Index to retrieve from

Returns:

Element at index

set

public SimpleTextFormatter set(int i,
                               SimpleTextFormatter element)

Description copied from interface: TextFormatter

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

Specified by:

set in interface TextFormatter<SimpleTextFormatter>

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<SimpleTextFormatter>

Returns:

Amount of elements

isEmpty

public boolean isEmpty()

Returns true if each partition is empty.

Specified by:

isEmpty in interface TextFormatter<SimpleTextFormatter>

Returns:

True if each partition is empty

contains

public boolean contains(SimpleTextFormatter element)

Description copied from interface: TextFormatter

Returns true if the specified element is in the formatter.

Specified by:

contains in interface TextFormatter<SimpleTextFormatter>

Parameters:

element - Element to check

Returns:

True if in formatter

clear

public void clear()

Clears each partition. Retains the actual partitions themselves.

Specified by:

clear in interface TextFormatter<SimpleTextFormatter>

add

public boolean add(SimpleTextFormatter element)

Description copied from interface: TextFormatter

Adds the specified element to the end of this formatter.

Specified by:

add in interface TextFormatter<SimpleTextFormatter>

Parameters:

element - Element to add

Returns:

True if the formatter changed as a result of the call

add

public boolean add(Collection<SimpleTextFormatter> elements)

Description copied from interface: TextFormatter

Adds the specified elements to the end of this formatter.

Specified by:

add in interface TextFormatter<SimpleTextFormatter>

Parameters:

elements - Elements to add

Returns:

True if the formatter changed as a result of the call

insert

public void insert(int i,
                   SimpleTextFormatter element)

Description copied from interface: TextFormatter

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

Specified by:

insert in interface TextFormatter<SimpleTextFormatter>

Parameters:

i - Index to insert at

element - Element to insert

insert

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

Description copied from interface: TextFormatter

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

Specified by:

insert in interface TextFormatter<SimpleTextFormatter>

Parameters:

i - Index to insert at

elements - Elements to insert

remove

public boolean remove(SimpleTextFormatter element)

Description copied from interface: TextFormatter

Removes the specified element from the formatter.

Specified by:

remove in interface TextFormatter<SimpleTextFormatter>

Parameters:

element - Element to remove

Returns:

True if this formatter contained the Element

remove

public boolean remove(Collection<SimpleTextFormatter> elements)

Description copied from interface: TextFormatter

Removes the specified elements from the formatter.

Specified by:

remove in interface TextFormatter<SimpleTextFormatter>

Parameters:

elements - Elements to remove

Returns:

True if the formatter changed as a result of this call

retain

public boolean retain(Collection<SimpleTextFormatter> elements)

Description copied from interface: TextFormatter

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

Specified by:

retain in interface TextFormatter<SimpleTextFormatter>

Parameters:

elements - Elements to retain

Returns:

True if the formatter changed as a result of this call