Package org.apache.commons.lang3.text
Class ExtendedMessageFormat
java.lang.Object
java.text.Format
java.text.MessageFormat
org.apache.commons.lang3.text.ExtendedMessageFormat
- All Implemented Interfaces:
Serializable,Cloneable
Deprecated.
As of 3.6, use Apache Commons Text
ExtendedMessageFormat instead
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, includingMessageFormatand thusExtendedMessageFormat, is not guaranteed.
- Since:
- 2.4
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.MessageFormat
MessageFormat.Field -
Constructor Summary
ConstructorsConstructorDescriptionExtendedMessageFormat(String pattern) Deprecated.Create a new ExtendedMessageFormat for the default locale.ExtendedMessageFormat(String pattern, Locale locale) Deprecated.Create a new ExtendedMessageFormat.ExtendedMessageFormat(String pattern, Locale locale, Map<String, ? extends FormatFactory> registry) Deprecated.Create a new ExtendedMessageFormat.ExtendedMessageFormat(String pattern, Map<String, ? extends FormatFactory> registry) Deprecated.Create a new ExtendedMessageFormat for the default locale. -
Method Summary
Modifier and TypeMethodDescriptionfinal voidapplyPattern(String pattern) Deprecated.Apply the specified pattern.booleanDeprecated.Check if this extended message format is equal to another object.inthashCode()Deprecated.voidDeprecated.Throws UnsupportedOperationException - see class Javadoc for details.voidsetFormatByArgumentIndex(int argumentIndex, Format newFormat) Deprecated.Throws UnsupportedOperationException - see class Javadoc for details.voidsetFormats(Format[] newFormats) Deprecated.Throws UnsupportedOperationException - see class Javadoc for details.voidsetFormatsByArgumentIndex(Format[] newFormats) Deprecated.Throws UnsupportedOperationException - see class Javadoc for details.Deprecated.Methods inherited from class java.text.MessageFormat
clone, format, format, format, formatToCharacterIterator, getFormats, getFormatsByArgumentIndex, getLocale, parse, parse, parseObject, setLocaleMethods inherited from class java.text.Format
format, parseObject
-
Constructor Details
-
ExtendedMessageFormat
Deprecated.Create a new ExtendedMessageFormat for the default locale.- Parameters:
pattern- the pattern to use, not null- Throws:
IllegalArgumentException- in case of a bad pattern.
-
ExtendedMessageFormat
Deprecated.Create 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) Deprecated.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:
IllegalArgumentException- in case of a bad pattern.
-
ExtendedMessageFormat
Deprecated.Create 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
Deprecated.Apply the specified pattern.- Overrides:
applyPatternin classMessageFormat- Parameters:
pattern- String
-
equals
Deprecated.Check if this extended message format is equal to another object.- Overrides:
equalsin classMessageFormat- Parameters:
obj- the object to compare to- Returns:
- true if this object equals the other, otherwise false
-
hashCode
Deprecated.- Overrides:
hashCodein classMessageFormat
-
setFormat
Deprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatin classMessageFormat- Parameters:
formatElementIndex- format element indexnewFormat- the new format- Throws:
UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
-
setFormatByArgumentIndex
Deprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatByArgumentIndexin classMessageFormat- Parameters:
argumentIndex- argument indexnewFormat- the new format- Throws:
UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
-
setFormats
Deprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatsin classMessageFormat- Parameters:
newFormats- new formats- Throws:
UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
-
setFormatsByArgumentIndex
Deprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatsByArgumentIndexin classMessageFormat- Parameters:
newFormats- new formats- Throws:
UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
-
toPattern
Deprecated.- Overrides:
toPatternin classMessageFormat
-