|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.text.Format
java.text.MessageFormat
org.apache.commons.lang.text.ExtendedMessageFormat
public class 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:
Formats, including MessageFormat and thus
ExtendedMessageFormat, is not guaranteed.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class java.text.MessageFormat |
|---|
MessageFormat.Field |
| Constructor Summary | |
|---|---|
ExtendedMessageFormat(String pattern)
Create a new ExtendedMessageFormat for the default locale. |
|
ExtendedMessageFormat(String pattern,
Locale locale)
Create a new ExtendedMessageFormat. |
|
ExtendedMessageFormat(String pattern,
Locale locale,
Map registry)
Create a new ExtendedMessageFormat. |
|
ExtendedMessageFormat(String pattern,
Map registry)
Create a new ExtendedMessageFormat for the default locale. |
|
| Method Summary | |
|---|---|
void |
applyPattern(String pattern)
Apply the specified pattern. |
boolean |
equals(Object obj)
Check if this extended message format is equal to another object. |
int |
hashCode()
Return the hashcode. |
void |
setFormat(int formatElementIndex,
Format newFormat)
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. |
String |
toPattern()
|
| 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 |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ExtendedMessageFormat(String pattern)
pattern - the pattern to use, not null
IllegalArgumentException - in case of a bad pattern.
public ExtendedMessageFormat(String pattern,
Locale locale)
pattern - the pattern to use, not nulllocale - the locale to use, not null
IllegalArgumentException - in case of a bad pattern.
public ExtendedMessageFormat(String pattern,
Map registry)
pattern - the pattern to use, not nullregistry - the registry of format factories, may be null
IllegalArgumentException - in case of a bad pattern.
public ExtendedMessageFormat(String pattern,
Locale locale,
Map registry)
pattern - the pattern to use, not nulllocale - the locale to use, not nullregistry - the registry of format factories, may be null
IllegalArgumentException - in case of a bad pattern.| Method Detail |
|---|
public String toPattern()
toPattern in class MessageFormatpublic final void applyPattern(String pattern)
applyPattern in class MessageFormatpattern - String
public void setFormat(int formatElementIndex,
Format newFormat)
setFormat in class MessageFormatformatElementIndex - format element indexnewFormat - the new format
UnsupportedOperationException
public void setFormatByArgumentIndex(int argumentIndex,
Format newFormat)
setFormatByArgumentIndex in class MessageFormatargumentIndex - argument indexnewFormat - the new format
UnsupportedOperationExceptionpublic void setFormats(Format[] newFormats)
setFormats in class MessageFormatnewFormats - new formats
UnsupportedOperationExceptionpublic void setFormatsByArgumentIndex(Format[] newFormats)
setFormatsByArgumentIndex in class MessageFormatnewFormats - new formats
UnsupportedOperationExceptionpublic boolean equals(Object obj)
equals in class MessageFormatobj - the object to compare to
public int hashCode()
hashCode in class MessageFormat
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||