ExtendedMessageFormat

@Deprecated public class org.apache.commons.lang3.text.ExtendedMessageFormat extends MessageFormat

Deprecated: As of 3.6, use Apache Commons Text ExtendedMessageFormat.

Extends java.text.MessageFormat to allow pluggable/additional formatting options for embedded format elements.

Client code should specify a registry of FormatFactory instances associated with String format names. This registry will be consulted when the format elements are parsed from the message pattern. In this way custom patterns can be specified, and the formats supported by java.text.MessageFormat can be overridden at the format and/or format style level (see MessageFormat). A “format element” embedded in the message pattern is specified (()? signifies optionality):

{argument-number(,format-name (,format-style)?)?}

format-name and format-style values are trimmed of surrounding whitespace in the manner of java.text.MessageFormat. If format-name denotes FormatFactory formatFactoryInstance in registry, a Format matching format-name and format-style is requested from formatFactoryInstance. If this is successful, the Format found is used for this format element.

NOTICE: The various subformat mutator methods are considered unnecessary; they exist on the parent class to allow the type of customization which it is the job of this class to provide in a configurable fashion. These methods have thus been disabled and will throw UnsupportedOperationException if called.

Limitations inherited from java.text.MessageFormat:

• When using “choice” subformats, support for nested formatting instructions is limited to that provided by the base class.

• Thread-safety of Formats, including MessageFormat and thus ExtendedMessageFormat, is not guaranteed.

Since:

2.4

Constructors

ExtendedMessageFormat(String)	Create a new ExtendedMessageFormat for the default locale.
ExtendedMessageFormat(String, Locale)	Create a new ExtendedMessageFormat.
ExtendedMessageFormat(String, Locale, Map)	Create a new ExtendedMessageFormat.
ExtendedMessageFormat(String, Map)	Create a new ExtendedMessageFormat for the default locale.

public ExtendedMessageFormat(String pattern)

Create a new ExtendedMessageFormat for the default locale.

Parameters:

pattern – The pattern to use, not null

Throws:

java.lang.IllegalArgumentException – Thrown in case of a bad pattern.

public ExtendedMessageFormat(String pattern, Locale locale)

Create a new ExtendedMessageFormat.

Parameters:

• pattern – The pattern to use, not null

• locale – The locale to use, not null

Throws:

java.lang.IllegalArgumentException – Thrown in case of a bad pattern.

public ExtendedMessageFormat(String pattern, Locale locale, Map<String, ? extends FormatFactory> registry)

Create a new ExtendedMessageFormat.

Parameters:

• pattern – The pattern to use, not null.

• locale – The locale to use.

• registry – The registry of format factories, may be null.

Throws:

java.lang.IllegalArgumentException – Thrown in case of a bad pattern.

public ExtendedMessageFormat(String pattern, Map<String, ? extends FormatFactory> registry)

Create a new ExtendedMessageFormat for the default locale.

Parameters:

• pattern – The pattern to use, not null

• registry – The registry of format factories, may be null

Throws:

java.lang.IllegalArgumentException – Thrown in case of a bad pattern.

Methods

applyPattern(String)	Apply the specified pattern.
equals(Object)
hashCode()
setFormat(int, Format)	Sets no format and always throws UnsupportedOperationException.
setFormatByArgumentIndex(int, Format)	Sets no format and always throws UnsupportedOperationException.
setFormats(Format[])	Sets no format and always throws UnsupportedOperationException.
setFormatsByArgumentIndex(Format[])	Sets no format and always throws UnsupportedOperationException.
toPattern()	[unresolved inheritDoc]

@Override public final void applyPattern(String pattern)

Apply the specified pattern.

Parameters:

pattern – String

@Override public boolean equals(Object obj)

@Override public int hashCode()

@Override public void setFormat(int formatElementIndex, Format newFormat)

Sets no format and always throws UnsupportedOperationException. See the class Javadoc for details.

Parameters:

• formatElementIndex – format element index

• newFormat – The new format

Throws:

java.lang.UnsupportedOperationException – Thrown because this operation is not supported.

@Override public void setFormatByArgumentIndex(int argumentIndex, Format newFormat)

Sets no format and always throws UnsupportedOperationException. See the class Javadoc for details.

Parameters:

• argumentIndex – argument index

• newFormat – The new format

Throws:

java.lang.UnsupportedOperationException – Thrown because this operation is not supported.

@Override public void setFormats(Format[] newFormats)

Sets no format and always throws UnsupportedOperationException. See the class Javadoc for details.

Parameters:

newFormats – new formats

Throws:

java.lang.UnsupportedOperationException – Thrown because this operation is not supported.

@Override public void setFormatsByArgumentIndex(Format[] newFormats)

Sets no format and always throws UnsupportedOperationException. See the class Javadoc for details.

Parameters:

newFormats – new formats

Throws:

java.lang.UnsupportedOperationException – Thrown because this operation is not supported.

@Override public String toPattern()

[unresolved inheritDoc]