Package org.apache.commons.lang.text
Class ExtendedMessageFormat
- java.lang.Object
-
- java.text.Format
-
- java.text.MessageFormat
-
- org.apache.commons.lang.text.ExtendedMessageFormat
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
public class ExtendedMessageFormat extends java.text.MessageFormat
Extendsjava.text.MessageFormat
to allow pluggable/additional formatting options for embedded format elements. Client code should specify a registry ofFormatFactory
instances associated withString
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 byjava.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 denotesFormatFactory formatFactoryInstance
inregistry
, aFormat
matching format-name and format-style is requested fromformatFactoryInstance
. If this is successful, theFormat
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
Format
s, includingMessageFormat
and thusExtendedMessageFormat
, is not guaranteed.
- Since:
- 2.4
- Version:
- $Id: ExtendedMessageFormat.java 1057427 2011-01-11 00:28:01Z niallp $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
DUMMY_PATTERN
private static char
END_FE
private static java.lang.String
ESCAPED_QUOTE
private static int
HASH_SEED
private static char
QUOTE
private java.util.Map
registry
private static long
serialVersionUID
private static char
START_FE
private static char
START_FMT
private java.lang.String
toPattern
-
Constructor Summary
Constructors Constructor Description ExtendedMessageFormat(java.lang.String pattern)
Create a new ExtendedMessageFormat for the default locale.ExtendedMessageFormat(java.lang.String pattern, java.util.Locale locale)
Create a new ExtendedMessageFormat.ExtendedMessageFormat(java.lang.String pattern, java.util.Locale locale, java.util.Map registry)
Create a new ExtendedMessageFormat.ExtendedMessageFormat(java.lang.String pattern, java.util.Map registry)
Create a new ExtendedMessageFormat for the default locale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private StrBuilder
appendQuotedString(java.lang.String pattern, java.text.ParsePosition pos, StrBuilder appendTo, boolean escapingOn)
Consume a quoted string, adding it toappendTo
if specified.void
applyPattern(java.lang.String pattern)
Apply the specified pattern.private boolean
containsElements(java.util.Collection coll)
Learn whether the specified Collection contains non-null elements.boolean
equals(java.lang.Object obj)
Check if this extended message format is equal to another object.private java.text.Format
getFormat(java.lang.String desc)
Get a custom format from a format description.private void
getQuotedString(java.lang.String pattern, java.text.ParsePosition pos, boolean escapingOn)
Consume quoted string onlyint
hashCode()
Return the hashcode.private java.lang.String
insertFormats(java.lang.String pattern, java.util.ArrayList customPatterns)
Insert formats back into the pattern for toPattern() support.private java.text.ParsePosition
next(java.text.ParsePosition pos)
Convenience method to advance parse position by 1private java.lang.String
parseFormatDescription(java.lang.String pattern, java.text.ParsePosition pos)
Parse the format component of a format element.private int
readArgumentIndex(java.lang.String pattern, java.text.ParsePosition pos)
Read the argument index from the current format elementprivate void
seekNonWs(java.lang.String pattern, java.text.ParsePosition pos)
Consume whitespace from the current parse position.void
setFormat(int formatElementIndex, java.text.Format newFormat)
Throws UnsupportedOperationException - see class Javadoc for details.void
setFormatByArgumentIndex(int argumentIndex, java.text.Format newFormat)
Throws UnsupportedOperationException - see class Javadoc for details.void
setFormats(java.text.Format[] newFormats)
Throws UnsupportedOperationException - see class Javadoc for details.void
setFormatsByArgumentIndex(java.text.Format[] newFormats)
Throws UnsupportedOperationException - see class Javadoc for details.java.lang.String
toPattern()
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
HASH_SEED
private static final int HASH_SEED
- See Also:
- Constant Field Values
-
DUMMY_PATTERN
private static final java.lang.String DUMMY_PATTERN
- See Also:
- Constant Field Values
-
ESCAPED_QUOTE
private static final java.lang.String ESCAPED_QUOTE
- See Also:
- Constant Field Values
-
START_FMT
private static final char START_FMT
- See Also:
- Constant Field Values
-
END_FE
private static final char END_FE
- See Also:
- Constant Field Values
-
START_FE
private static final char START_FE
- See Also:
- Constant Field Values
-
QUOTE
private static final char QUOTE
- See Also:
- Constant Field Values
-
toPattern
private java.lang.String toPattern
-
registry
private final java.util.Map registry
-
-
Constructor Detail
-
ExtendedMessageFormat
public ExtendedMessageFormat(java.lang.String pattern)
Create a new ExtendedMessageFormat for the default locale.- Parameters:
pattern
- the pattern to use, not null- Throws:
java.lang.IllegalArgumentException
- in case of a bad pattern.
-
ExtendedMessageFormat
public ExtendedMessageFormat(java.lang.String pattern, java.util.Locale locale)
Create a new ExtendedMessageFormat.- Parameters:
pattern
- the pattern to use, not nulllocale
- the locale to use, not null- Throws:
java.lang.IllegalArgumentException
- in case of a bad pattern.
-
ExtendedMessageFormat
public ExtendedMessageFormat(java.lang.String pattern, java.util.Map registry)
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:
java.lang.IllegalArgumentException
- in case of a bad pattern.
-
ExtendedMessageFormat
public ExtendedMessageFormat(java.lang.String pattern, java.util.Locale locale, java.util.Map registry)
Create 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:
java.lang.IllegalArgumentException
- in case of a bad pattern.
-
-
Method Detail
-
toPattern
public java.lang.String toPattern()
- Overrides:
toPattern
in classjava.text.MessageFormat
-
applyPattern
public final void applyPattern(java.lang.String pattern)
Apply the specified pattern.- Overrides:
applyPattern
in classjava.text.MessageFormat
- Parameters:
pattern
- String
-
setFormat
public void setFormat(int formatElementIndex, java.text.Format newFormat)
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormat
in classjava.text.MessageFormat
- Parameters:
formatElementIndex
- format element indexnewFormat
- the new format- Throws:
java.lang.UnsupportedOperationException
-
setFormatByArgumentIndex
public void setFormatByArgumentIndex(int argumentIndex, java.text.Format newFormat)
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatByArgumentIndex
in classjava.text.MessageFormat
- Parameters:
argumentIndex
- argument indexnewFormat
- the new format- Throws:
java.lang.UnsupportedOperationException
-
setFormats
public void setFormats(java.text.Format[] newFormats)
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormats
in classjava.text.MessageFormat
- Parameters:
newFormats
- new formats- Throws:
java.lang.UnsupportedOperationException
-
setFormatsByArgumentIndex
public void setFormatsByArgumentIndex(java.text.Format[] newFormats)
Throws UnsupportedOperationException - see class Javadoc for details.- Overrides:
setFormatsByArgumentIndex
in classjava.text.MessageFormat
- Parameters:
newFormats
- new formats- Throws:
java.lang.UnsupportedOperationException
-
equals
public boolean equals(java.lang.Object obj)
Check if this extended message format is equal to another object.- Overrides:
equals
in classjava.text.MessageFormat
- Parameters:
obj
- the object to compare to- Returns:
- true if this object equals the other, otherwise false
- Since:
- 2.6
-
hashCode
public int hashCode()
Return the hashcode.- Overrides:
hashCode
in classjava.text.MessageFormat
- Returns:
- the hashcode
- Since:
- 2.6
-
getFormat
private java.text.Format getFormat(java.lang.String desc)
Get a custom format from a format description.- Parameters:
desc
- String- Returns:
- Format
-
readArgumentIndex
private int readArgumentIndex(java.lang.String pattern, java.text.ParsePosition pos)
Read the argument index from the current format element- Parameters:
pattern
- pattern to parsepos
- current parse position- Returns:
- argument index
-
parseFormatDescription
private java.lang.String parseFormatDescription(java.lang.String pattern, java.text.ParsePosition pos)
Parse the format component of a format element.- Parameters:
pattern
- string to parsepos
- current parse position- Returns:
- Format description String
-
insertFormats
private java.lang.String insertFormats(java.lang.String pattern, java.util.ArrayList customPatterns)
Insert formats back into the pattern for toPattern() support.- Parameters:
pattern
- sourcecustomPatterns
- The custom patterns to re-insert, if any- Returns:
- full pattern
-
seekNonWs
private void seekNonWs(java.lang.String pattern, java.text.ParsePosition pos)
Consume whitespace from the current parse position.- Parameters:
pattern
- String to readpos
- current position
-
next
private java.text.ParsePosition next(java.text.ParsePosition pos)
Convenience method to advance parse position by 1- Parameters:
pos
- ParsePosition- Returns:
pos
-
appendQuotedString
private StrBuilder appendQuotedString(java.lang.String pattern, java.text.ParsePosition pos, StrBuilder appendTo, boolean escapingOn)
Consume a quoted string, adding it toappendTo
if specified.- Parameters:
pattern
- pattern to parsepos
- current parse positionappendTo
- optional StringBuffer to appendescapingOn
- whether to process escaped quotes- Returns:
appendTo
-
getQuotedString
private void getQuotedString(java.lang.String pattern, java.text.ParsePosition pos, boolean escapingOn)
Consume quoted string only- Parameters:
pattern
- pattern to parsepos
- current parse positionescapingOn
- whether to process escaped quotes
-
containsElements
private boolean containsElements(java.util.Collection coll)
Learn whether the specified Collection contains non-null elements.- Parameters:
coll
- to check- Returns:
true
if some Object was found,false
otherwise.
-
-