public class MessageFormat extends UFormat
java.text.MessageFormat. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.
MessageFormat prepares strings for display to users, with optional arguments (variables/placeholders). The arguments can occur in any order, which is necessary for translation into languages with different grammars.
A MessageFormat is constructed from a pattern string with arguments in {curly braces} which will be replaced by formatted values.
MessageFormat differs from the other Format
classes in that you create a MessageFormat object with one
of its constructors (not with a getInstance style factory
method). Factory methods aren't necessary because MessageFormat
itself doesn't implement locale-specific behavior. Any locale-specific
behavior is defined by the pattern that you provide and the
subformats used for inserted arguments.
Arguments can be named (using identifiers) or numbered (using small ASCII-digit integers).
Some of the API methods work only with argument numbers and throw an exception
if the pattern has named arguments (see usesNamedArguments()).
An argument might not specify any format type. In this case, a Number value is formatted with a default (for the locale) NumberFormat, a Date value is formatted with a default (for the locale) DateFormat, and for any other value its toString() value is used.
An argument might specify a "simple" type for which the specified Format object is created, cached and used.
An argument might have a "complex" type with nested MessageFormat sub-patterns. During formatting, one of these sub-messages is selected according to the argument value and recursively formatted.
After construction, a custom Format object can be set for a top-level argument, overriding the default formatting and parsing behavior for that argument. However, custom formatting can be achieved more simply by writing a typeless argument in the pattern string and supplying it with a preformatted string value.
When formatting, MessageFormat takes a collection of argument values and writes an output string. The argument values may be passed as an array (when the pattern contains only numbered arguments) or as a Map (which works for both named and numbered arguments).
Each argument is matched with one of the input values by array index or map key and formatted according to its pattern specification (or using a custom Format object if one was set). A numbered pattern argument is matched with a map key that contains that number as an ASCII-decimal-digit string (without leading zero).
MessageFormat uses patterns of the following form:
message = messageText (argument messageText)*
argument = noneArg | simpleArg | complexArg
complexArg = choiceArg | pluralArg | selectArg | selectordinalArg
noneArg = '{' argNameOrNumber '}'
simpleArg = '{' argNameOrNumber ',' argType [',' argStyle] '}'
choiceArg = '{' argNameOrNumber ',' "choice" ',' choiceStyle '}'
pluralArg = '{' argNameOrNumber ',' "plural" ',' pluralStyle '}'
selectArg = '{' argNameOrNumber ',' "select" ',' selectStyle '}'
selectordinalArg = '{' argNameOrNumber ',' "selectordinal" ',' pluralStyle '}'
choiceStyle: see ChoiceFormat
pluralStyle: see PluralFormat
selectStyle: see SelectFormat
argNameOrNumber = argName | argNumber
argName = [^[[:Pattern_Syntax:][:Pattern_White_Space:]]]+
argNumber = '0' | ('1'..'9' ('0'..'9')*)
argType = "number" | "date" | "time" | "spellout" | "ordinal" | "duration"
argStyle = "short" | "medium" | "long" | "full" | "integer" | "currency" | "percent" | argStyleText | "::" argSkeletonText
MessagePattern.ApostropheMode
Recommendation: Use the real apostrophe (single quote) character \\u2019 for human-readable text, and use the ASCII apostrophe (\\u0027 ' ) only in program syntax, like quoting in MessageFormat. See the annotations for U+0027 Apostrophe in The Unicode Standard.
The choice argument type is deprecated.
Use plural arguments for proper plural selection,
and select arguments for simple selection among a fixed set of choices.
The argType and argStyle values are used to create
a Format instance for the format element. The following
table shows how the values map to Format instances. Combinations not
shown in the table are illegal. Any argStyleText must
be a valid pattern string for the Format subclass used.
| argType | argStyle | resulting Format object |
|---|---|---|
| (none) | null
| |
number
| (none) | NumberFormat.getInstance(getLocale())
|
integer
| NumberFormat.getIntegerInstance(getLocale())
| |
currency
| NumberFormat.getCurrencyInstance(getLocale())
| |
percent
| NumberFormat.getPercentInstance(getLocale())
| |
| argStyleText | new DecimalFormat(argStyleText, new DecimalFormatSymbols(getLocale()))
| |
| argSkeletonText | NumberFormatter.forSkeleton(argSkeletonText).locale(getLocale()).toFormat()
| |
date
| (none) | DateFormat.getDateInstance(DateFormat.DEFAULT, getLocale())
|
short
| DateFormat.getDateInstance(DateFormat.SHORT, getLocale())
| |
medium
| DateFormat.getDateInstance(DateFormat.DEFAULT, getLocale())
| |
long
| DateFormat.getDateInstance(DateFormat.LONG, getLocale())
| |
full
| DateFormat.getDateInstance(DateFormat.FULL, getLocale())
| |
| argStyleText | new SimpleDateFormat(argStyleText, getLocale())
| |
time
| (none) | DateFormat.getTimeInstance(DateFormat.DEFAULT, getLocale())
|
short
| DateFormat.getTimeInstance(DateFormat.SHORT, getLocale())
| |
medium
| DateFormat.getTimeInstance(DateFormat.DEFAULT, getLocale())
| |
long
| DateFormat.getTimeInstance(DateFormat.LONG, getLocale())
| |
full
| DateFormat.getTimeInstance(DateFormat.FULL, getLocale())
| |
| argStyleText | new SimpleDateFormat(argStyleText, getLocale())
| |
spellout
| argStyleText (optional) | new RuleBasedNumberFormat(getLocale(), RuleBasedNumberFormat.SPELLOUT)
|
ordinal
| argStyleText (optional) | new RuleBasedNumberFormat(getLocale(), RuleBasedNumberFormat.ORDINAL)
|
duration
| argStyleText (optional) | new RuleBasedNumberFormat(getLocale(), RuleBasedNumberFormat.DURATION)
|
The ICU MessageFormat supports both named and numbered arguments, while the JDK MessageFormat only supports numbered arguments. Named arguments make patterns more readable.
ICU implements a more user-friendly apostrophe quoting syntax.
In message text, an apostrophe only begins quoting literal text
if it immediately precedes a syntax character (mostly {curly braces}).
In the JDK MessageFormat, an apostrophe always begins quoting,
which requires common text like "don't" and "aujourd'hui"
to be written with doubled apostrophes like "don''t" and "aujourd''hui".
For more details see MessagePattern.ApostropheMode.
ICU does not create a ChoiceFormat object for a choiceArg, pluralArg or selectArg
but rather handles such arguments itself.
The JDK MessageFormat does create and use a ChoiceFormat object
(new ChoiceFormat(argStyleText)).
The JDK does not support plural and select arguments at all.
Here are some examples of usage:
Object[] arguments = {
7,
new Date(System.currentTimeMillis()),
"a disturbance in the Force"
};
String result = MessageFormat.format(
"At {1,time} on {1,date}, there was {2} on planet {0,number,integer}.",
arguments);
output: At 12:30 PM on Jul 3, 2053, there was a disturbance
in the Force on planet 7.
Typically, the message format will come from resources, and the
arguments will be dynamically set at runtime.
Example 2:
Object[] testArgs = { 3, "MyDisk" };
MessageFormat form = new MessageFormat(
"The disk \"{1}\" contains {0} file(s).");
System.out.println(form.format(testArgs));
// output, with different testArgs
output: The disk "MyDisk" contains 0 file(s).
output: The disk "MyDisk" contains 1 file(s).
output: The disk "MyDisk" contains 1,273 file(s).
For messages that include plural forms, you can use a plural argument:
MessageFormat msgFmt = new MessageFormat(
"{num_files, plural, " +
"=0{There are no files on disk \"{disk_name}\".}" +
"=1{There is one file on disk \"{disk_name}\".}" +
"other{There are # files on disk \"{disk_name}\".}}",
ULocale.ENGLISH);
Map args = new HashMap();
args.put("num_files", 0);
args.put("disk_name", "MyDisk");
System.out.println(msgFmt.format(args));
args.put("num_files", 3);
System.out.println(msgFmt.format(args));
output:
There are no files on disk "MyDisk".
There are 3 files on "MyDisk".
See PluralFormat and PluralRules for details.
MessageFormats are not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.
Locale,
Format,
NumberFormat,
DecimalFormat,
ChoiceFormat,
PluralFormat,
SelectFormat,
Serialized Form| Modifier and Type | Class and Description |
|---|---|
static class |
MessageFormat.Field
Defines constants that are used as attribute keys in the
AttributedCharacterIterator returned
from MessageFormat.formatToCharacterIterator. |
| Constructor and Description |
|---|
MessageFormat(java.lang.String pattern)
Constructs a MessageFormat for the default
FORMAT locale and the
specified pattern. |
MessageFormat(java.lang.String pattern,
java.util.Locale locale)
Constructs a MessageFormat for the specified locale and
pattern.
|
MessageFormat(java.lang.String pattern,
ULocale locale)
Constructs a MessageFormat for the specified locale and
pattern.
|
| Modifier and Type | Method and Description |
|---|---|
void |
applyPattern(java.lang.String pttrn)
Sets the pattern used by this message format.
|
void |
applyPattern(java.lang.String pattern,
MessagePattern.ApostropheMode aposMode)
[icu] Sets the ApostropheMode and the pattern used by this message format.
|
static java.lang.String |
autoQuoteApostrophe(java.lang.String pattern)
[icu] Converts an 'apostrophe-friendly' pattern into a standard
pattern.
|
java.lang.Object |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.StringBuffer |
format(java.util.Map<java.lang.String,java.lang.Object> arguments,
java.lang.StringBuffer result,
java.text.FieldPosition pos)
Formats a map of objects and appends the
MessageFormat's
pattern, with arguments replaced by the formatted objects, to the
provided StringBuffer. |
java.lang.StringBuffer |
format(java.lang.Object[] arguments,
java.lang.StringBuffer result,
java.text.FieldPosition pos)
Formats an array of objects and appends the
MessageFormat's
pattern, with arguments replaced by the formatted objects, to the
provided StringBuffer. |
java.lang.StringBuffer |
format(java.lang.Object arguments,
java.lang.StringBuffer result,
java.text.FieldPosition pos)
Formats a map or array of objects and appends the
MessageFormat's
pattern, with format elements replaced by the formatted objects, to the
provided StringBuffer. |
static java.lang.String |
format(java.lang.String pattern,
java.util.Map<java.lang.String,java.lang.Object> arguments)
Creates a MessageFormat with the given pattern and uses it to
format the given arguments.
|
static java.lang.String |
format(java.lang.String pattern,
java.lang.Object... arguments)
Creates a MessageFormat with the given pattern and uses it
to format the given arguments.
|
java.text.AttributedCharacterIterator |
formatToCharacterIterator(java.lang.Object arguments)
Formats an array of objects and inserts them into the
MessageFormat's pattern, producing an
AttributedCharacterIterator. |
MessagePattern.ApostropheMode |
getApostropheMode()
[icu]
|
java.util.Set<java.lang.String> |
getArgumentNames()
[icu] Returns the top-level argument names.
|
java.text.Format |
getFormatByArgumentName(java.lang.String argumentName)
[icu] Returns the first top-level format associated with the given argument name.
|
java.text.Format[] |
getFormats()
Returns the Format objects used for the format elements in the
previously set pattern string.
|
java.text.Format[] |
getFormatsByArgumentIndex()
Returns the Format objects used for the values passed into
format methods or returned from parse
methods. |
java.util.Locale |
getLocale()
Returns the locale that's used when creating or comparing subformats.
|
ULocale |
getULocale()
[icu] Returns the locale that's used when creating argument Format objects.
|
int |
hashCode() |
java.lang.Object[] |
parse(java.lang.String source)
Parses text from the beginning of the given string to produce an object
array.
|
java.lang.Object[] |
parse(java.lang.String source,
java.text.ParsePosition pos)
Parses the string.
|
java.lang.Object |
parseObject(java.lang.String source,
java.text.ParsePosition pos)
Parses text from a string to produce an object array or Map.
|
java.util.Map<java.lang.String,java.lang.Object> |
parseToMap(java.lang.String source)
[icu] Parses text from the beginning of the given string to produce a map from
argument to values.
|
java.util.Map<java.lang.String,java.lang.Object> |
parseToMap(java.lang.String source,
java.text.ParsePosition pos)
[icu] Parses the string, returning the results in a Map.
|
void |
setFormat(int formatElementIndex,
java.text.Format newFormat)
Sets the Format object to use for the format element with the given
format element index within the previously set pattern string.
|
void |
setFormatByArgumentIndex(int argumentIndex,
java.text.Format newFormat)
Sets the Format object to use for the format elements within the
previously set pattern string that use the given argument
index.
|
void |
setFormatByArgumentName(java.lang.String argumentName,
java.text.Format newFormat)
[icu] Sets the Format object to use for the format elements within the
previously set pattern string that use the given argument
name.
|
void |
setFormats(java.text.Format[] newFormats)
Sets the Format objects to use for the format elements in the
previously set pattern string.
|
void |
setFormatsByArgumentIndex(java.text.Format[] newFormats)
Sets the Format objects to use for the values passed into
format methods or returned from parse
methods. |
void |
setFormatsByArgumentName(java.util.Map<java.lang.String,java.text.Format> newFormats)
[icu] Sets the Format objects to use for the values passed into
format methods or returned from parse
methods. |
void |
setLocale(java.util.Locale locale)
Sets the locale to be used for creating argument Format objects.
|
void |
setLocale(ULocale locale)
Sets the locale to be used for creating argument Format objects.
|
java.lang.String |
toPattern()
Returns the applied pattern string.
|
boolean |
usesNamedArguments()
[icu] Returns true if this MessageFormat uses named arguments,
and false otherwise.
|
public MessageFormat(java.lang.String pattern)
FORMAT locale and the
specified pattern.
Sets the locale and calls applyPattern(pattern).pattern - the pattern for this message formatjava.lang.IllegalArgumentException - if the pattern is invalidULocale.Category.FORMATpublic MessageFormat(java.lang.String pattern,
java.util.Locale locale)
pattern - the pattern for this message formatlocale - the locale for this message formatjava.lang.IllegalArgumentException - if the pattern is invalidpublic MessageFormat(java.lang.String pattern,
ULocale locale)
pattern - the pattern for this message formatlocale - the locale for this message formatjava.lang.IllegalArgumentException - if the pattern is invalidpublic void setLocale(java.util.Locale locale)
applyPattern
method as well as to the format and
formatToCharacterIterator methods.locale - the locale to be used when creating or comparing subformatspublic void setLocale(ULocale locale)
applyPattern
method as well as to the format and
formatToCharacterIterator methods.locale - the locale to be used when creating or comparing subformatspublic java.util.Locale getLocale()
public ULocale getULocale()
public void applyPattern(java.lang.String pttrn)
pttrn - the pattern for this message formatjava.lang.IllegalArgumentException - if the pattern is invalidpublic void applyPattern(java.lang.String pattern,
MessagePattern.ApostropheMode aposMode)
This method is best used only once on a given object to avoid confusion about the mode, and after constructing the object with an empty pattern string to minimize overhead.
pattern - the pattern for this message formataposMode - the new ApostropheModejava.lang.IllegalArgumentException - if the pattern is invalidMessagePattern.ApostropheModepublic MessagePattern.ApostropheMode getApostropheMode()
public java.lang.String toPattern()
java.lang.IllegalStateException - after custom Format objects have been set
via setFormat() or similar APIspublic void setFormatsByArgumentIndex(java.text.Format[] newFormats)
format methods or returned from parse
methods. The indices of elements in newFormats
correspond to the argument indices used in the previously set
pattern string.
The order of formats in newFormats thus corresponds to
the order of elements in the arguments array passed
to the format methods or the result array returned
by the parse methods.
If an argument index is used for more than one format element
in the pattern string, then the corresponding new format is used
for all such format elements. If an argument index is not used
for any format element in the pattern string, then the
corresponding new format is ignored. If fewer formats are provided
than needed, then only the formats for argument indices less
than newFormats.length are replaced.
This method is only supported if the format does not use
named arguments, otherwise an IllegalArgumentException is thrown.
newFormats - the new formats to usejava.lang.NullPointerException - if newFormats is nulljava.lang.IllegalArgumentException - if this formatter uses named argumentspublic void setFormatsByArgumentName(java.util.Map<java.lang.String,java.text.Format> newFormats)
format methods or returned from parse
methods. The keys in newFormats are the argument
names in the previously set pattern string, and the values
are the formats.
Only argument names from the pattern string are considered.
Extra keys in newFormats that do not correspond
to an argument name are ignored. Similarly, if there is no
format in newFormats for an argument name, the formatter
for that argument remains unchanged.
This may be called on formats that do not use named arguments. In this case the map will be queried for key Strings that represent argument indices, e.g. "0", "1", "2" etc.
newFormats - a map from String to Format providing new
formats for named arguments.public void setFormats(java.text.Format[] newFormats)
newFormats corresponds to
the order of format elements in the pattern string.
If more formats are provided than needed by the pattern string,
the remaining ones are ignored. If fewer formats are provided
than needed, then only the first newFormats.length
formats are replaced.
Since the order of format elements in a pattern string often
changes during localization, it is generally better to use the
setFormatsByArgumentIndex
method, which assumes an order of formats corresponding to the
order of elements in the arguments array passed to
the format methods or the result array returned by
the parse methods.
newFormats - the new formats to usejava.lang.NullPointerException - if newFormats is nullpublic void setFormatByArgumentIndex(int argumentIndex,
java.text.Format newFormat)
arguments array passed
to the format methods or the result array returned
by the parse methods.
If the argument index is used for more than one format element in the pattern string, then the new format is used for all such format elements. If the argument index is not used for any format element in the pattern string, then the new format is ignored. This method is only supported when exclusively numbers are used for argument names. Otherwise an IllegalArgumentException is thrown.
argumentIndex - the argument index for which to use the new formatnewFormat - the new format to usejava.lang.IllegalArgumentException - if this format uses named argumentspublic void setFormatByArgumentName(java.lang.String argumentName,
java.text.Format newFormat)
If the argument name is used for more than one format element in the pattern string, then the new format is used for all such format elements. If the argument name is not used for any format element in the pattern string, then the new format is ignored.
This API may be used on formats that do not use named arguments.
In this case argumentName should be a String that names
an argument index, e.g. "0", "1", "2"... etc. If it does not name
a valid index, the format will be ignored. No error is thrown.
argumentName - the name of the argument to changenewFormat - the new format to usepublic void setFormat(int formatElementIndex,
java.text.Format newFormat)
Since the order of format elements in a pattern string often
changes during localization, it is generally better to use the
setFormatByArgumentIndex
method, which accesses format elements based on the argument
index they specify.
formatElementIndex - the index of a format element within the patternnewFormat - the format to use for the specified format elementjava.lang.ArrayIndexOutOfBoundsException - if formatElementIndex is equal to or
larger than the number of format elements in the pattern stringpublic java.text.Format[] getFormatsByArgumentIndex()
format methods or returned from parse
methods. The indices of elements in the returned array
correspond to the argument indices used in the previously set
pattern string.
The order of formats in the returned array thus corresponds to
the order of elements in the arguments array passed
to the format methods or the result array returned
by the parse methods.
If an argument index is used for more than one format element in the pattern string, then the format used for the last such format element is returned in the array. If an argument index is not used for any format element in the pattern string, then null is returned in the array. This method is only supported when exclusively numbers are used for argument names. Otherwise an IllegalArgumentException is thrown.
java.lang.IllegalArgumentException - if this format uses named argumentspublic java.text.Format[] getFormats()
Since the order of format elements in a pattern string often
changes during localization, it's generally better to use the
getFormatsByArgumentIndex()
method, which assumes an order of formats corresponding to the
order of elements in the arguments array passed to
the format methods or the result array returned by
the parse methods.
This method is only supported when exclusively numbers are used for
argument names. Otherwise an IllegalArgumentException is thrown.
java.lang.IllegalArgumentException - if this format uses named argumentspublic java.util.Set<java.lang.String> getArgumentNames()
setFormatByArgumentName(String, Format).public java.text.Format getFormatByArgumentName(java.lang.String argumentName)
setFormatByArgumentName(String, Format).argumentName - The name of the desired argument.public final java.lang.StringBuffer format(java.lang.Object[] arguments,
java.lang.StringBuffer result,
java.text.FieldPosition pos)
MessageFormat's
pattern, with arguments replaced by the formatted objects, to the
provided StringBuffer.
The text substituted for the individual format elements is derived from
the current subformat of the format element and the
arguments element at the format element's argument index
as indicated by the first matching line of the following table. An
argument is unavailable if arguments is
null or has fewer than argumentIndex+1 elements. When
an argument is unavailable no substitution is performed.
| argType or Format | value object | Formatted Text |
|---|---|---|
| any | unavailable | "{" + argNameOrNumber + "}"
|
| any | null
| "null"
|
custom Format != null
| any | customFormat.format(argument)
|
noneArg, or custom Format == null
| instanceof Number
| NumberFormat.getInstance(getLocale()).format(argument)
|
noneArg, or custom Format == null
| instanceof Date
| DateFormat.getDateTimeInstance(DateFormat.SHORT,
DateFormat.SHORT, getLocale()).format(argument)
|
noneArg, or custom Format == null
| instanceof String
| argument
|
noneArg, or custom Format == null
| any | argument.toString()
|
| complexArg | any | result of recursive formatting of a selected sub-message |
If pos is non-null, and refers to
Field.ARGUMENT, the location of the first formatted
string will be returned.
This method is only supported when the format does not use named
arguments, otherwise an IllegalArgumentException is thrown.
arguments - an array of objects to be formatted and substituted.result - where text is appended.pos - On input: an alignment field, if desired.
On output: the offsets of the alignment field.java.lang.IllegalArgumentException - if a value in the
arguments array is not of the type
expected by the corresponding argument or custom Format object.java.lang.IllegalArgumentException - if this format uses named argumentspublic final java.lang.StringBuffer format(java.util.Map<java.lang.String,java.lang.Object> arguments,
java.lang.StringBuffer result,
java.text.FieldPosition pos)
MessageFormat's
pattern, with arguments replaced by the formatted objects, to the
provided StringBuffer.
The text substituted for the individual format elements is derived from
the current subformat of the format element and the
arguments value corresopnding to the format element's
argument name.
A numbered pattern argument is matched with a map key that contains that number as an ASCII-decimal-digit string (without leading zero).
An argument is unavailable if arguments is
null or does not have a value corresponding to an argument
name in the pattern. When an argument is unavailable no substitution
is performed.
arguments - a map of objects to be formatted and substituted.result - where text is appended.pos - On input: an alignment field, if desired.
On output: the offsets of the alignment field.java.lang.IllegalArgumentException - if a value in the
arguments array is not of the type
expected by the corresponding argument or custom Format object.public static java.lang.String format(java.lang.String pattern,
java.lang.Object... arguments)
(new MessageFormat(pattern)).format(arguments, new StringBuffer(), null).toString()
java.lang.IllegalArgumentException - if the pattern is invalidjava.lang.IllegalArgumentException - if a value in the
arguments array is not of the type
expected by the corresponding argument or custom Format object.java.lang.IllegalArgumentException - if this format uses named argumentspublic static java.lang.String format(java.lang.String pattern,
java.util.Map<java.lang.String,java.lang.Object> arguments)
java.lang.IllegalArgumentException - if the pattern is invalidjava.lang.IllegalArgumentException - if a value in the
arguments array is not of the type
expected by the corresponding argument or custom Format object.format(Map, StringBuffer, FieldPosition),
format(String, Object[])public boolean usesNamedArguments()
public final java.lang.StringBuffer format(java.lang.Object arguments,
java.lang.StringBuffer result,
java.text.FieldPosition pos)
MessageFormat's
pattern, with format elements replaced by the formatted objects, to the
provided StringBuffer.
This is equivalent to either of
A map must be provided if this format uses named arguments, otherwise an IllegalArgumentException will be thrown.format((Object[]) arguments, result, pos)format((Map) arguments, result, pos)
format in class java.text.Formatarguments - a map or array of objects to be formattedresult - where text is appendedpos - On input: an alignment field, if desired
On output: the offsets of the alignment fieldjava.lang.IllegalArgumentException - if an argument in
arguments is not of the type
expected by the format element(s) that use itjava.lang.IllegalArgumentException - if arguments is
an array of Object and this format uses named argumentspublic java.text.AttributedCharacterIterator formatToCharacterIterator(java.lang.Object arguments)
MessageFormat's pattern, producing an
AttributedCharacterIterator.
You can use the returned AttributedCharacterIterator
to build the resulting String, as well as to determine information
about the resulting String.
The text of the returned AttributedCharacterIterator is
the same that would be returned by
format(arguments, new StringBuffer(), null).toString()
In addition, the AttributedCharacterIterator contains at
least attributes indicating where text was generated from an
argument in the arguments array. The keys of these attributes are of
type MessageFormat.Field, their values are
Integer objects indicating the index in the arguments
array of the argument from which the text was generated.
The attributes/value from the underlying Format
instances that MessageFormat uses will also be
placed in the resulting AttributedCharacterIterator.
This allows you to not only find where an argument is placed in the
resulting String, but also which fields it contains in turn.
formatToCharacterIterator in class java.text.Formatarguments - an array of objects to be formatted and substituted.java.lang.NullPointerException - if arguments is null.java.lang.IllegalArgumentException - if a value in the
arguments array is not of the type
expected by the corresponding argument or custom Format object.public java.lang.Object[] parse(java.lang.String source,
java.text.ParsePosition pos)
Caveats: The parse may fail in a number of circumstances. For example:
java.lang.IllegalArgumentException - if this format uses named argumentspublic java.util.Map<java.lang.String,java.lang.Object> parseToMap(java.lang.String source,
java.text.ParsePosition pos)
source - the text to parsepos - the position at which to start parsing. on return,
contains the result of the parse.public java.lang.Object[] parse(java.lang.String source)
throws java.text.ParseException
See the parse(String, ParsePosition) method for more information
on message parsing.
source - A String whose beginning should be parsed.Object array parsed from the string.java.text.ParseException - if the beginning of the specified string cannot be parsed.java.lang.IllegalArgumentException - if this format uses named argumentspublic java.util.Map<java.lang.String,java.lang.Object> parseToMap(java.lang.String source)
throws java.text.ParseException
See the parse(String, ParsePosition) method for more information on
message parsing.
source - A String whose beginning should be parsed.Map parsed from the string.java.text.ParseException - if the beginning of the specified string cannot
be parsed.parseToMap(String, ParsePosition)public java.lang.Object parseObject(java.lang.String source,
java.text.ParsePosition pos)
The method attempts to parse text starting at the index given by
pos.
If parsing succeeds, then the index of pos is updated
to the index after the last character used (parsing does not necessarily
use all characters up to the end of the string), and the parsed
object array is returned. The updated pos can be used to
indicate the starting point for the next call to this method.
If an error occurs, then the index of pos is not
changed, the error index of pos is set to the index of
the character where the error occurred, and null is returned.
See the parse(String, ParsePosition) method for more information
on message parsing.
parseObject in class java.text.Formatsource - A String, part of which should be parsed.pos - A ParsePosition object with index and error
index information as described above.Object parsed from the string, either an
array of Object, or a Map, depending on whether named
arguments are used. This can be queried using usesNamedArguments.
In case of error, returns null.java.lang.NullPointerException - if pos is null.public java.lang.Object clone()
clone in class java.text.Formatpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic static java.lang.String autoQuoteApostrophe(java.lang.String pattern)
MessageFormat.
See the class description for more about apostrophes and quoting,
and differences between ICU and MessageFormat.
MessageFormat and ICU 4.6 and earlier MessageFormat
treat all ASCII apostrophes as
quotes, which is problematic in some languages, e.g.
French, where apostrophe is commonly used. This utility
assumes that only an unpaired apostrophe immediately before
a brace is a true quote. Other unpaired apostrophes are paired,
and the resulting standard pattern string is returned.
Note: It is not guaranteed that the returned pattern is indeed a valid pattern. The only effect is to convert between patterns having different quoting semantics.
Note: This method only works on top-level messageText, not messageText nested inside a complexArg.
pattern - the 'apostrophe-friendly' pattern to convertCopyright © 2016 Unicode, Inc. and others.