Package org.kingdoms.locale.compiler

Class MessageObject

java.lang.Object

org.kingdoms.locale.compiler.MessageObject

All Implemented Interfaces:

MessageObjectBuilder

Direct Known Subclasses:

CombinedMessageObject, ContextualMessageObject

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)

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	evaluateDynamicPieces(MessagePlaceholderProvider placeholderContextProvider)	Gives a pure MessageObject that doesn't require a placeholder provider anymore.
MessageObject	filter(Predicate<MessagePiece> filter)
List<MessagePiece>	findColorPieces(int colorIndex, boolean backwards)
MessageObject	findLastColors()
static MessageObject	from(Boolean usePrefix, MessagePiece... pieces)
static MessageObject	from(MessagePiece... pieces)
AdvancedMessageProvider	getExtraProvider()
MessagePiece[]	getPieces()
MessageProvider	getSimpleProvider()
Boolean	getUsePrefix()
boolean	hasPiece(Predicate<MessagePiece> filter)
boolean	isAvailable(MessagePlaceholderProvider builder)	Whether any of this message object's methods can be used.
boolean	isNull()	Mostly happens when a line is only condition based and the condition isn't matched, so the entire line is omitted.
MessageObject	merge(boolean after, MessagePiece... others)
MessageObject	merge(MessageObject... others)
static MessagePiece[]	mergeObjectToPieces(MessageObject... objects)
<I extends MessagePiece, O extends MessagePiece> MessageObject	replace(Predicate<MessagePiece> filter, Function<I,O> replacement)
List<MessageObject>	splitBy(boolean preservePiece, Predicate<MessagePiece> predicate)
List<MessageObject>	splitLines()	Splits this message object to multiple lines (if new line character is available) and makes each line inherit the color of its previous line.
String	toString()
MessagePiece	validateAll(Predicate<MessagePiece> validator)
ContextualMessageObject	withContext(MessagePlaceholderProvider context)

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

buildComplex, buildPlain

Field Details

NULL

public static final MessageObject NULL

pieces

protected final MessagePiece[] pieces

Constructor Details

MessageObject

public MessageObject(MessagePiece[] pieces,
 Boolean usePrefix)

Method Details

from

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

from

public static MessageObject from(MessagePiece... pieces)

validateAll

public MessagePiece validateAll(Predicate<MessagePiece> validator)

getPieces

public MessagePiece[] getPieces()

getUsePrefix

public Boolean getUsePrefix()

isNull

public boolean isNull()

Mostly happens when a line is only condition based and the condition isn't matched, so the entire line is omitted.

splitBy

public List<MessageObject> splitBy(boolean preservePiece,
 Predicate<MessagePiece> predicate)

hasPiece

public boolean hasPiece(Predicate<MessagePiece> filter)

count

public int count(Predicate<MessagePiece> filter)

combine

public static MessageObject combine(MessageObject... objects)

withContext

public ContextualMessageObject withContext(MessagePlaceholderProvider context)

mergeObjectToPieces

public static MessagePiece[] mergeObjectToPieces(MessageObject... objects)

merge

public MessageObject merge(MessageObject... others)

merge

public MessageObject merge(boolean after,
 MessagePiece... others)

filter

public MessageObject filter(Predicate<MessagePiece> filter)

findLastColors

public MessageObject findLastColors()

splitLines

public List<MessageObject> splitLines()

Splits this message object to multiple lines (if new line character is available) and makes each line inherit the color of its previous line.

replace

public <I extends MessagePiece,
O extends MessagePiece>
MessageObject replace(Predicate<MessagePiece> filter,
 Function<I,O> replacement)

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(MessagePlaceholderProvider builder)

Description copied from interface: MessageObjectBuilder

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

Specified by:

isAvailable in interface MessageObjectBuilder

evaluateDynamicPieces

public MessageObject evaluateDynamicPieces(MessagePlaceholderProvider placeholderContextProvider)

Gives a pure MessageObject that doesn't require a placeholder provider anymore. All message pieces that require placeholders/context are evaluated and turned into constant message pieces.

Specified by:

evaluateDynamicPieces in interface MessageObjectBuilder

getSimpleProvider

public MessageProvider getSimpleProvider()

getExtraProvider

public AdvancedMessageProvider getExtraProvider()

toString

public String toString()

Overrides:

toString in class Object