Package org.dellroad.stuff.text

Class MessageFmt.FormatArgumentSegment<T extends Format>

java.lang.Object

org.dellroad.stuff.text.MessageFmt.Segment

org.dellroad.stuff.text.MessageFmt.ArgumentSegment

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

Type Parameters:

T - type of Format used to format the argument

Direct Known Subclasses:

MessageFmt.DateFormatArgumentSegment, MessageFmt.NumberFormatArgumentSegment

Enclosing class:

MessageFmt

public abstract static class MessageFmt.FormatArgumentSegment<T extends Format>
extends MessageFmt.ArgumentSegment

An MessageFmt.ArgumentSegment that formats its argument using a Format of some kind.

Use FormatArgumentSegment.of() to produce a concrete instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FormatArgumentSegment()
protected	FormatArgumentSegment(int argumentNumber)

Method Summary

Modifier and Type	Method	Description
static <T extends Format> MessageFmt.FormatArgumentSegment<T>	of(T format, int argumentNumber, Locale locale)	Map the given argument Format into the corresponding MessageFmt.ArgumentSegment.

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

equals, getArgumentNumber, getArgumentSuffix, hashCode, setArgumentNumber, toPattern, toString

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

visit

Methods inherited from class java.lang.Object

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

Constructor Details

FormatArgumentSegment

protected FormatArgumentSegment()

FormatArgumentSegment

protected FormatArgumentSegment(int argumentNumber)

Method Details

of

public static <T extends Format>
MessageFmt.FormatArgumentSegment<T> of(T format,
 int argumentNumber,
 Locale locale)

Map the given argument Format into the corresponding MessageFmt.ArgumentSegment.

The optional locale parameter allows for identification of certain formats when they equal the locale default. This also results in more concise MessageFormat format strings (see MessageFmt.toPattern()), but makes the result implicitly depend on the Locale being used (because different Locales have different defaults for integer, percent, currency, etc).

Type Parameters:

T - format type

Parameters:

format - format to be used for argument

argumentNumber - argument number

locale - assumed locale, or null to not make any locale assumptions

Returns:

an equivalent MessageFmt.FormatArgumentSegment

Throws:

IllegalArgumentException - if argumentNumber is negative

IllegalArgumentException - if format is null or cannot be deciphered