Package org.kingdoms.locale.compiler

Class MessageObject

java.lang.Object

org.kingdoms.locale.compiler.MessageObject

All Implemented Interfaces:

MessageObjectBuilder

public class MessageObject
extends Object
implements MessageObjectBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final MessageObject	NULL
protected final MessagePiece[]	pieces

Constructor Summary

Constructors

Constructor	Description
MessageObject(MessagePiece[] pieces, Boolean usePrefix, MessageCompilerSettings compilerSettings)

Method Summary

Modifier and Type	Method	Description
void	build(ComplexMessageBuilderContextProvider contextProvider)
void	build(HTMLMessageBuilderContextProvider contextProvider)
void	build(PlainMessageBuilderContextProvider contextProvider)
static MessageObject	combine(MessageObject... objects)
int	count(Predicate<MessagePiece> filter)
MessageObject	evaluatePlaceholdersOnly(MessageBuilder placeholderContextProvider)	Evaluates MessagePiece.Variable into their own individual pieces after being translated.
MessageObject	filter(Predicate<MessagePiece> filter)
List<MessagePiece>	findColorPieces(int colorIndex, boolean backwards)
MessageObject	findLastColors()
static MessageObject	from(Boolean usePrefix, MessageCompilerSettings settings, MessagePiece... pieces)
MessageCompilerSettings	getCompilerSettings()
AdvancedMessageProvider	getExtraProvider()
MessagePiece[]	getPieces()
MessageProvider	getSimpleProvider()
boolean	hasPiece(Predicate<MessagePiece> filter)
boolean	isAvailable(MessageBuilder builder)	Whether any of this message object's methods can be used.
MessageObject	merge(MessageObject... others)
List<MessageObject>	splitBy(Predicate<MessagePiece> predicate)
String	toString()
MessagePiece	validateAll(Predicate<MessagePiece> validator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kingdoms.locale.compiler.builders.MessageObjectBuilder

build, buildComplex, buildPlain

Field Details

NULL

public static final MessageObject NULL

pieces

protected final MessagePiece[] pieces

Constructor Details

MessageObject

public MessageObject(MessagePiece[] pieces,
 Boolean usePrefix,
 MessageCompilerSettings compilerSettings)

Method Details

from

public static MessageObject from(Boolean usePrefix,
 MessageCompilerSettings settings,
 MessagePiece... pieces)

getCompilerSettings

public MessageCompilerSettings getCompilerSettings()

validateAll

public MessagePiece validateAll(Predicate<MessagePiece> validator)

getPieces

public MessagePiece[] getPieces()

splitBy

public List<MessageObject> splitBy(Predicate<MessagePiece> predicate)

hasPiece

public boolean hasPiece(Predicate<MessagePiece> filter)

count

public int count(Predicate<MessagePiece> filter)

combine

public static MessageObject combine(MessageObject... objects)

merge

public MessageObject merge(MessageObject... others)

filter

public MessageObject filter(Predicate<MessagePiece> filter)

findLastColors

public MessageObject findLastColors()

findColorPieces

public List<MessagePiece> findColorPieces(int colorIndex,
 boolean backwards)

build

public void build(ComplexMessageBuilderContextProvider contextProvider)

Specified by:

build in interface MessageObjectBuilder

build

public void build(PlainMessageBuilderContextProvider contextProvider)

Specified by:

build in interface MessageObjectBuilder

build

public void build(HTMLMessageBuilderContextProvider contextProvider)

Specified by:

build in interface MessageObjectBuilder

isAvailable

public boolean isAvailable(MessageBuilder builder)

Description copied from interface: MessageObjectBuilder

Whether any of this message object's methods can be used.

Specified by:

isAvailable in interface MessageObjectBuilder

evaluatePlaceholdersOnly

public MessageObject evaluatePlaceholdersOnly(MessageBuilder placeholderContextProvider)

Description copied from interface: MessageObjectBuilder

Evaluates MessagePiece.Variable into their own individual pieces after being translated. This is useful for knowing the exact length and structure of the message which can be used to obtain the last colors in a message which itself is useful for multi-line situations such as color in items.

Specified by:

evaluatePlaceholdersOnly in interface MessageObjectBuilder

getSimpleProvider

public MessageProvider getSimpleProvider()

getExtraProvider

public AdvancedMessageProvider getExtraProvider()

toString

public String toString()

Overrides:

toString in class Object