Package org.dellroad.stuff.text

Class MessageFmt.ChoiceArgumentSegment

java.lang.Object

org.dellroad.stuff.text.MessageFmt.Segment

org.dellroad.stuff.text.MessageFmt.ArgumentSegment

org.dellroad.stuff.text.MessageFmt.FormatArgumentSegment<T>

org.dellroad.stuff.text.MessageFmt.NumberFormatArgumentSegment<ChoiceFormat>

org.dellroad.stuff.text.MessageFmt.ChoiceArgumentSegment

Enclosing class:

MessageFmt

public static class MessageFmt.ChoiceArgumentSegment
extends MessageFmt.NumberFormatArgumentSegment<ChoiceFormat>

An MessageFmt.ArgumentSegment that formats its argument using a ChoiceFormat.

When a MessageFormat executes a nested ChoiceFormat, if the resulting string contains a '{' then the string is recursively interpreted again as a MessageFormat pattern. Therefore, the semantics of a ChoiceFormat differ when treated standalone vs. nested in a MessageFormat.

This class models the latter scenario. Each option of the choice is modeled as a new, nested MessageFormat (see MessageFmt.ChoiceArgumentSegment.Option) regardless of whether '{' appeared in the original pattern for the choice. This simplifies the model but also means that if the original choice pattern didn't contain '{', then the MessageFormat modeling that choice will have escaping applied to its format string, preserving the net effect.

See Also:

• MessageFmt.ChoiceArgumentSegment.Option

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageFmt.ChoiceArgumentSegment.Option	Represents one option in a MessageFmt.ChoiceArgumentSegment.

Constructor Summary

Constructors

Constructor	Description
ChoiceArgumentSegment()
ChoiceArgumentSegment(int argumentNumber, ChoiceFormat format)	Create an instance modeling the given ChoiceFormat.
ChoiceArgumentSegment(int argumentNumber, MessageFmt.ChoiceArgumentSegment.Option... options)	Create an instance from explicitly given MessageFmt.ChoiceArgumentSegment.Options.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected String	getArgumentSuffix()	Get the MessageFormat pattern string argument suffix, if any.
@NotNull @Size(min=1) @Valid List<@NotNull MessageFmt.ChoiceArgumentSegment.Option>	getOptions()	Get the possible options.
int	hashCode()
void	setOptions(List<MessageFmt.ChoiceArgumentSegment.Option> options)
ChoiceFormat	toChoiceFormat()	Build the ChoiceFormat represented by this instance.
String	toString()
void	visit(MessageFmt.SegmentSwitch target)	Visit the method of the given switch corresponding to this instance's concrete type.

Methods inherited from class org.dellroad.stuff.text.MessageFmt.FormatArgumentSegment

of

Methods inherited from class org.dellroad.stuff.text.MessageFmt.ArgumentSegment

getArgumentNumber, setArgumentNumber, toPattern

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChoiceArgumentSegment

public ChoiceArgumentSegment()

ChoiceArgumentSegment

public ChoiceArgumentSegment(int argumentNumber,
 MessageFmt.ChoiceArgumentSegment.Option... options)

Create an instance from explicitly given MessageFmt.ChoiceArgumentSegment.Options.

Parameters:

argumentNumber - the index of the argument formatted by this segment

options - choice options

Throws:

IllegalArgumentException - if options or any element thereof is null

ChoiceArgumentSegment

public ChoiceArgumentSegment(int argumentNumber,
 ChoiceFormat format)

Create an instance modeling the given ChoiceFormat.

Parameters:

argumentNumber - argument number

format - source format

Throws:

IllegalArgumentException - if format is null

See Also:

• toChoiceFormat()

Method Details

getOptions

@NotNull
@Size(min=1)
@Valid
public @NotNull @Size(min=1) @Valid List<@NotNull MessageFmt.ChoiceArgumentSegment.Option> getOptions()

Get the possible options.

Returns:

options for choice

setOptions

public void setOptions(List<MessageFmt.ChoiceArgumentSegment.Option> options)

toChoiceFormat

public ChoiceFormat toChoiceFormat()

Build the ChoiceFormat represented by this instance.

Returns:

an equivalent ChoiceFormat

getArgumentSuffix

protected String getArgumentSuffix()

Description copied from class: MessageFmt.ArgumentSegment

Get the MessageFormat pattern string argument suffix, if any.

If present, this suffix follows the argument number and a comma, and precedes the closing curly brace.

Used by MessageFmt.ArgumentSegment.toPattern().

Specified by:

getArgumentSuffix in class MessageFmt.ArgumentSegment

Returns:

pattern string argument suffix, or null if none needed

visit

public void visit(MessageFmt.SegmentSwitch target)

Description copied from class: MessageFmt.Segment

Visit the method of the given switch corresponding to this instance's concrete type.

Specified by:

visit in class MessageFmt.Segment

Parameters:

target - visitor pattern target

equals

public boolean equals(Object obj)

Overrides:

equals in class MessageFmt.ArgumentSegment

hashCode

public int hashCode()

Overrides:

hashCode in class MessageFmt.ArgumentSegment

toString

public String toString()

Overrides:

toString in class MessageFmt.ArgumentSegment