org.spongepowered.api.event.message

Class MessageEvent.MessageFormatter

java.lang.Object

org.spongepowered.api.text.transform.FixedPartitionedTextFormatter

org.spongepowered.api.event.message.MessageEvent.MessageFormatter

All Implemented Interfaces:

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

Enclosing interface:

MessageEvent

public static class MessageEvent.MessageFormatter
extends FixedPartitionedTextFormatter

Formatter used for formatting messages within this event. This formatter is partitioned into three sections: header, body, and footer. This is in an effort to make formatting messages much more flexible and modular for developers allowing for appending/inserting prefixes, adding suffixes, etc.

Constructor Summary

Constructors

Constructor and Description
MessageFormatter()
MessageFormatter(Text body)
MessageFormatter(Text header, Text body)

Method Summary

Modifier and Type	Method and Description
SimpleTextFormatter	getBody() Returns the body partition within this formatter.
SimpleTextFormatter	getFooter() Returns the footer partition within this formatter.
SimpleTextFormatter	getHeader() Returns the header partition within this formatter.
void	setBody(TextRepresentable body) Clears any existing components within the body partition and adds a new TextTemplateApplier to the partition with the specified value.
void	setFooter(TextRepresentable footer) Clears any existing components within the footer partition and adds a new TextTemplateApplier to the partition with the specified value.
void	setHeader(TextRepresentable header) Clears any existing components within the header partition and adds a new TextTemplateApplier to the partition with the specified value.

Methods inherited from class org.spongepowered.api.text.transform.FixedPartitionedTextFormatter

add, add, clear, contains, get, getAll, insert, insert, isEmpty, remove, remove, retain, set, size

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

MessageFormatter

public MessageFormatter()

MessageFormatter

public MessageFormatter(Text header,
                        Text body)

MessageFormatter

public MessageFormatter(Text body)

Method Detail

getHeader

public SimpleTextFormatter getHeader()

Returns the header partition within this formatter.

Returns:

Header partition

setHeader

public void setHeader(TextRepresentable header)

Clears any existing components within the header partition and adds a new TextTemplateApplier to the partition with the specified value.

Parameters:

header - Header value

getBody

public SimpleTextFormatter getBody()

Returns the body partition within this formatter.

Returns:

Body partition

setBody

public void setBody(TextRepresentable body)

Clears any existing components within the body partition and adds a new TextTemplateApplier to the partition with the specified value.

Parameters:

body - Body value

getFooter

public SimpleTextFormatter getFooter()

Returns the footer partition within this formatter.

Returns:

Footer partition

setFooter

public void setFooter(TextRepresentable footer)

Clears any existing components within the footer partition and adds a new TextTemplateApplier to the partition with the specified value.

Parameters:

footer - Footer value