Package org.apache.commons.text
Class ExtendedMessageFormat
java.lang.Object
java.text.Format
java.text.MessageFormat
org.apache.commons.text.ExtendedMessageFormat
- All Implemented Interfaces:
Serializable
,Cloneable
Extends
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 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):{}<i>argument-number</i><b>(</b>{@code ,}<i>format-name</i><b>
(</b>{@code ,}<i>format-style</i><b>)?)?</b>{@code }
format-name and format-style values are trimmed of surrounding whitespace
in the manner of 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 MessageFormat
:
- When using "choice" subformats, support for nested formatting instructions is limited to that provided by the base class.
- Thread-safety of
Format
s, includingMessageFormat
and thusExtendedMessageFormat
, is not guaranteed.
- Since:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.MessageFormat
MessageFormat.Field
-
Constructor Summary
ConstructorDescriptionExtendedMessageFormat
(String pattern) Constructs a new ExtendedMessageFormat for the default locale.ExtendedMessageFormat
(String pattern, Locale locale) Constructs a new ExtendedMessageFormat.ExtendedMessageFormat
(String pattern, Locale locale, Map<String, ? extends FormatFactory> registry) Constructs a new ExtendedMessageFormat.ExtendedMessageFormat
(String pattern, Map<String, ? extends FormatFactory> registry) Constructs a new ExtendedMessageFormat for the default locale. -
Method Summary
Modifier and TypeMethodDescriptionfinal void
applyPattern
(String pattern) Applies the specified pattern.boolean
Tests if this extended message format is equal to another object.int
hashCode()
void
Throws UnsupportedOperationException - see class Javadoc for details.void
setFormatByArgumentIndex
(int argumentIndex, Format newFormat) Throws UnsupportedOperationException - see class Javadoc for details.void
setFormats
(Format[] newFormats) Throws UnsupportedOperationException - see class Javadoc for details.void
setFormatsByArgumentIndex
(Format[] newFormats) Throws UnsupportedOperationException - see class Javadoc for details.Methods inherited from class java.text.MessageFormat
clone, format, format, format, formatToCharacterIterator, getFormats, getFormatsByArgumentIndex, getLocale, parse, parse, parseObject, setLocale
Methods inherited from class java.text.Format
format, parseObject
-
Constructor Details
-
ExtendedMessageFormat
Constructs a new ExtendedMessageFormat for the default locale.- Parameters:
pattern
- the pattern to use, not null- Throws:
IllegalArgumentException
- in case of a bad pattern.
-
ExtendedMessageFormat
Constructs a new ExtendedMessageFormat.- Parameters:
pattern
- the pattern to use, not nulllocale
- the locale to use, not null- Throws:
IllegalArgumentException
- in case of a bad pattern.
-
ExtendedMessageFormat
public ExtendedMessageFormat(String pattern, Locale locale, Map<String, ? extends FormatFactory> registry) Constructs a new ExtendedMessageFormat.- Parameters:
pattern
- the pattern to use, not nulllocale
- the locale to use, not nullregistry
- the registry of format factories, may be null- Throws:
IllegalArgumentException
- in case of a bad pattern.
-
ExtendedMessageFormat
Constructs a new ExtendedMessageFormat for the default locale.- Parameters:
pattern
- the pattern to use, not nullregistry
- the registry of format factories, may be null- Throws:
IllegalArgumentException
- in case of a bad pattern.
-
-
Method Details
-
applyPattern
Applies the specified pattern.- Overrides:
applyPattern
in classMessageFormat
- Parameters:
pattern
- String
-
equals
Tests if this extended message format is equal to another object.- Overrides:
equals
in classMessageFormat
- Parameters:
obj
- the object to compare to- Returns:
- true if this object equals the other, otherwise false
-
hashCode
- Overrides:
hashCode
in classMessageFormat
-
setFormat
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormat
in classMessageFormat
- Parameters:
formatElementIndex
- format element indexnewFormat
- the new format- Throws:
UnsupportedOperationException
- always thrown since this isn't supported by ExtendMessageFormat
-
setFormatByArgumentIndex
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatByArgumentIndex
in classMessageFormat
- Parameters:
argumentIndex
- argument indexnewFormat
- the new format- Throws:
UnsupportedOperationException
- always thrown since this isn't supported by ExtendMessageFormat
-
setFormats
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormats
in classMessageFormat
- Parameters:
newFormats
- new formats- Throws:
UnsupportedOperationException
- always thrown since this isn't supported by ExtendMessageFormat
-
setFormatsByArgumentIndex
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatsByArgumentIndex
in classMessageFormat
- Parameters:
newFormats
- new formats- Throws:
UnsupportedOperationException
- always thrown since this isn't supported by ExtendMessageFormat
-
toPattern
- Overrides:
toPattern
in classMessageFormat
-