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 
 
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):{argument-number(,format-name
 (,format-style)?)?}
 
 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 Formats, includingMessageFormatand thusExtendedMessageFormat, is not guaranteed.
- Since:
- 2.4
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from class java.text.MessageFormatMessageFormat.Field
- 
Constructor SummaryConstructorsConstructorDescriptionExtendedMessageFormat(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 SummaryModifier 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.MessageFormatclone, format, format, format, formatToCharacterIterator, getFormats, getFormatsByArgumentIndex, getLocale, parse, parse, parseObject, setLocaleMethods inherited from class java.text.Formatformat, parseObject
- 
Constructor Details- 
ExtendedMessageFormatDeprecated.Create a new ExtendedMessageFormat for the default locale.- Parameters:
- pattern- the pattern to use, not null
- Throws:
- IllegalArgumentException- in case of a bad pattern.
 
- 
ExtendedMessageFormatDeprecated.Create a new ExtendedMessageFormat.- Parameters:
- pattern- the pattern to use, not null
- locale- the locale to use, not null
- Throws:
- IllegalArgumentException- in case of a bad pattern.
 
- 
ExtendedMessageFormatpublic 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.
 
- 
ExtendedMessageFormatDeprecated.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:
- IllegalArgumentException- in case of a bad pattern.
 
 
- 
- 
Method Details- 
applyPatternDeprecated.Apply the specified pattern.- Overrides:
- applyPatternin class- MessageFormat
- Parameters:
- pattern- String
 
- 
equalsDeprecated.Check if this extended message format is equal to another object.- Overrides:
- equalsin class- MessageFormat
- Parameters:
- obj- the object to compare to
- Returns:
- true if this object equals the other, otherwise false
 
- 
hashCodeDeprecated.- Overrides:
- hashCodein class- MessageFormat
 
- 
setFormatDeprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
- setFormatin class- MessageFormat
- Parameters:
- formatElementIndex- format element index
- newFormat- the new format
- Throws:
- UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
 
- 
setFormatByArgumentIndexDeprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
- setFormatByArgumentIndexin class- MessageFormat
- Parameters:
- argumentIndex- argument index
- newFormat- the new format
- Throws:
- UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
 
- 
setFormatsDeprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
- setFormatsin class- MessageFormat
- Parameters:
- newFormats- new formats
- Throws:
- UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
 
- 
setFormatsByArgumentIndexDeprecated.Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
- setFormatsByArgumentIndexin class- MessageFormat
- Parameters:
- newFormats- new formats
- Throws:
- UnsupportedOperationException- always thrown since this isn't supported by ExtendMessageFormat
 
- 
toPatternDeprecated.- Overrides:
- toPatternin class- MessageFormat
 
 
-