MessageFormat

MessageFormat

MessageFormat (String pattern)

构造默认FORMAT区域设置和指定模式的MessageFormat。 设置语言环境并调用applyPattern（模式）。

MessageFormat

MessageFormat (String pattern, 
                Locale locale)

为指定的语言环境和模式构造MessageFormat。 设置语言环境并调用applyPattern（模式）。

MessageFormat

MessageFormat (String pattern, 
                ULocale locale)

为指定的语言环境和模式构造MessageFormat。 设置语言环境并调用applyPattern（模式）。

applyPattern

void applyPattern (String pttrn)

设置此消息格式使用的模式。 分析模式并为简单参数类型缓存Format对象。 模式及其解释在class description中指定。

applyPattern

void applyPattern (String pattern, 
                MessagePattern.ApostropheMode aposMode)

[icu]设置此消息格式所使用的ApostropheMode和模式。 分析模式并为简单参数类型缓存Format对象。 模式及其解释在class description中指定。

对于给定的对象，此方法最好只使用一次，以避免对模式造成混淆，并且在使用空的模式字符串构造对象以最小化开销之后。

autoQuoteApostrophe

String autoQuoteApostrophe (String pattern)

[icu]将'撇号友好'模式转换为标准模式。 对于ICU 4.8和更高版本的MessageFormat模式字符串，这已过时。 它可以与MessageFormat一起使用。

有关撇号和引用以及ICU和 MessageFormat之间的差异，请参阅班级说明。

MessageFormat和ICU 4.6及更早版本的MessageFormat将所有ASCII撇号视为引号，这在某些语言中是有问题的，例如法语，其中通常使用撇号。 该实用程序假定只有紧跟在括号之前的不成对的撇号是真实的引号。 其他未配对的撇号已配对，并返回生成的标准模式字符串。

注意 ：不能保证返回的模式确实是一个有效的模式。 唯一的影响是在具有不同引用语义的模式之间进行转换。

注意 ：此方法仅适用于顶层messageText，而不适用嵌套在complexArg内的messageText。

clone

Object clone ()

创建并返回此对象的副本。

equals

boolean equals (Object obj)

指示其他某个对象是否“等于”这一个。

equals方法在非空对象引用上实现等价关系：

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

类Object的equals方法实现了对象上最可能的等价关系; 也就是说，对于任何非空参考值x和y ，当且仅当x和y指向同一对象（ x == y的值为true ）时，此方法返回true 。

请注意，无论何时覆盖此方法，通常都需要覆盖 hashCode方法，以便维护 hashCode方法的一般合同，该方法声明相等对象必须具有相同的哈希代码。

format

StringBuffer format (Object[] arguments, 
                StringBuffer result, 
                FieldPosition pos)

格式化对象数组，并将 MessageFormat的模式（其参数替换为格式化对象）附加到提供的 StringBuffer 。

替换各个格式元素的文本是从格式元素的当前子格式和格式元素的参数索引处的arguments元素派生的，如下表的第一个匹配行所示。 如果arguments是null或少于argumentIndex + 1元素，则参数不可用 。 当参数不可用时，不执行替换。

如果pos非空，并且引用Field.ARGUMENT ，则返回第一个格式化字符串的位置。 只有格式不使用命名参数时才支持此方法，否则会引发IllegalArgumentException。

format

String format (String pattern, 
                Map<String, Object> arguments)

用给定的模式创建一个MessageFormat并使用它来格式化给定的参数。 该模式必须按名称而不是数字来标识参数。

format

StringBuffer format (Object arguments, 
                StringBuffer result, 
                FieldPosition pos)

格式化地图或对象数组，并将MessageFormat的模式（格式化元素替换为格式化对象） StringBuffer到提供的StringBuffer 。 这相当于任一个

format((Object[]) arguments, result, pos) format((Map) arguments, result, pos)

format

StringBuffer format (Map<String, Object> arguments, 
                StringBuffer result, 
                FieldPosition pos)

格式化对象的映射并将 MessageFormat的模式附加到提供的 StringBuffer ，并将格式化对象替换为参数。

替换单个格式元素的文本是从格式元素的当前子格式导出的，并且 arguments值将对应于格式元素的参数名称。

编号模式参数与包含该数字的映射键匹配为ASCII十进制数字串（不包含前导零）。

如果arguments是null或者模式中没有与参数名称对应的值，则参数不可用 。 当参数不可用时，不执行替换。

format

String format (String pattern, 
                Object... arguments)

用给定的模式创建一个MessageFormat并使用它来格式化给定的参数。 这相当于

(new MessageFormat(pattern)).format(arguments, new StringBuffer(), null).toString()

formatToCharacterIterator

AttributedCharacterIterator formatToCharacterIterator (Object arguments)

格式化一组对象并将它们插入到MessageFormat的模式中，产生一个AttributedCharacterIterator 。 您可以使用返回的AttributedCharacterIterator来生成结果字符串，以及确定有关生成的字符串的信息。

返回的 AttributedCharacterIterator的文本与将返回的文本相同

format(arguments, new StringBuffer(), null).toString()

此外， AttributedCharacterIterator至少包含指示arguments数组中参数生成文本的属性。 这些属性的键类型为MessageFormat.Field ，它们的值为Integer对象，该对象指示生成文本的参数的arguments数组中的索引。

从底层的属性/值Format实例即MessageFormat用途也将被放置在所得AttributedCharacterIterator 。 这使您不仅可以找到参数在结果字符串中的位置，而且还可以找到它包含的字段。

getApostropheMode

MessagePattern.ApostropheMode getApostropheMode ()

[ICU]

getArgumentNames

Set<String> getArgumentNames ()

[icu]返回顶级参数名称。 有关更多详细信息，请参阅setFormatByArgumentName(String, Format) 。

getFormatByArgumentName

Format getFormatByArgumentName (String argumentName)

[icu]返回与给定参数名称关联的第一个顶级格式。 有关更多详细信息，请参阅setFormatByArgumentName(String, Format) 。

getFormats

Format[] getFormats ()

返回用于先前设置的模式字符串中格式元素的Format对象。 返回数组中格式的顺序对应于模式字符串中格式元素的顺序。

由于模式字符串中格式元素的顺序在本地化过程中经常发生变化，因此使用getFormatsByArgumentIndex()方法通常会更好，该方法假定格式顺序与arguments数组中传递给format方法或返回结果数组的元素顺序相对应由parse方法。 仅当数字用于参数名称时才支持此方法。 否则会引发IllegalArgumentException。

getFormatsByArgumentIndex

Format[] getFormatsByArgumentIndex ()

返回用于传递给format方法或从parse方法返回的值的Format对象。 返回数组中元素的索引与先前设置的模式字符串中使用的参数索引相对应。 返回数组中格式的顺序因此对应于传递给format方法的arguments数组中元素的顺序或format方法返回的结果数组的parse 。

如果参数索引用于模式字符串中的多个格式元素，则用于最后一个这样的格式元素的格式将返回到数组中。 如果参数索引不用于模式字符串中的任何格式元素，则返回数组中的null。 仅当数字用于参数名称时才支持此方法。 否则会引发IllegalArgumentException。

getLocale

Locale getLocale ()

返回创建或比较子格式时使用的语言环境。

getULocale

ULocale getULocale ()

[icu]返回创建参数Format对象时使用的语言环境。

hashCode

int hashCode ()

返回对象的哈希码值。 为了散列表的好处而支持此方法，例如由HashMap提供的HashMap 。

一般合同 hashCode是：

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

尽可能合理实用，类Object定义的hashCode方法确实会为不同的对象返回不同的整数。 （这通常通过将对象的内部地址转换为整数来实现，但Java ^TM编程语言不需要此实现技术。）

parse

Object[] parse (String source)

从给定字符串的开头分析文本以生成对象数组。 该方法可能不会使用给定字符串的整个文本。

有关消息解析的更多信息，请参阅 parse(String, ParsePosition)方法。

parse

Object[] parse (String source, 
                ParsePosition pos)

分析字符串。

注意事项：在许多情况下，解析可能会失败。 例如：

• If one of the arguments does not occur in the pattern.
• If the format of an argument loses information, such as with a choice format where a large number formats to "many".
• Does not yet handle recursion (where the substituted strings contain {n} references.)
• Will not always find a match (or the correct match) if some part of the parse is ambiguous. For example, if the pattern "{1},{2}" is used with the string arguments {"a,b", "c"}, it will format as "a,b,c". When the result is parsed, it will return {"a", "b,c"}.
• If a single argument is parsed more than once in the string, then the later parse wins.

parseObject

Object parseObject (String source, 
                ParsePosition pos)

分析字符串中的文本以生成对象数组或映射。

该方法尝试解析从pos给出的索引开始的文本。 如果解析成功，则在使用最后一个字符（解析不一定使用到字符串末尾的所有字符）之后，将索引pos更新为索引，并返回解析的对象数组。 已更新的pos可用于指示下一次调用此方法的起点。 如果发生错误，则pos的索引不会更改，将错误索引pos设置为发生错误的字符的索引，并返回null。

有关消息解析的更多信息，请参阅 parse(String, ParsePosition)方法。

parseToMap

Map<String, Object> parseToMap (String source)

[icu]解析给定字符串开始处的文本，以生成从参数到值的映射。 该方法可能不会使用给定字符串的整个文本。

有关消息解析的更多信息，请参阅 parse(String, ParsePosition)方法。

parseToMap

Map<String, Object> parseToMap (String source, 
                ParsePosition pos)

[icu]解析字符串，将结果返回到Map中。 这与返回Object数组的版本类似。 这支持命名和编号参数 - 如果编号，映射中的键是相应的ASCII十进制数字串（例如“0”，“1”，“2”...）。

setFormat

void setFormat (int formatElementIndex, 
                Format newFormat)

将格式对象设置为在先前设置的模式字符串中用于具有给定格式元素索引的格式元素。 格式元素索引是从模式字符串开始计数的格式元素的从零开始的数字。

由于模式字符串中格式元素的顺序在本地化过程中经常发生变化，因此通常使用 setFormatByArgumentIndex方法更好，该方法根据它们指定的参数索引访问格式元素。

setFormatByArgumentIndex

void setFormatByArgumentIndex (int argumentIndex, 
                Format newFormat)

设置Format对象以用于之前设置的模式字符串中使用给定参数索引的格式元素。 参数索引是格式元素定义的一部分，表示传递给format方法的arguments数组或由parse方法返回的结果数组的parse 。

如果参数索引用于模式字符串中的多个格式元素，则新格式将用于所有此类格式元素。 如果参数索引不用于模式字符串中的任何格式元素，则新格式将被忽略。 仅当数字用于参数名称时才支持此方法。 否则会引发IllegalArgumentException。

setFormatByArgumentName

void setFormatByArgumentName (String argumentName, 
                Format newFormat)

[icu]将Format对象设置为用于先前设置的模式字符串中使用给定参数名称的格式元素。

如果参数名称用于模式字符串中的多个格式元素，则新格式将用于所有此类格式元素。 如果参数名称未用于模式字符串中的任何格式元素，则新格式将被忽略。

该API可用于不使用命名参数的格式。 在这种情况下， argumentName应该是一个用于命名参数索引的字符串，例如“0”，“1”，“2”等。如果它没有命名有效索引，则格式将被忽略。 没有错误被抛出。

setFormats

void setFormats (Format[] newFormats)

设置Format对象以用于先前设置的模式字符串中的格式元素。 格式在newFormats中的顺序对应于模式字符串中的格式元素的顺序。

如果提供了比模式字符串所需格式更多的格式，则其余格式将被忽略。 如果提供的格式少于需要的格式，则只替换第一个newFormats.length格式。

由于模式字符串中格式元素的顺序在本地化过程中经常发生变化，通常使用 setFormatsByArgumentIndex方法会更好，该方法假定格式顺序与 arguments数组中传递给 format方法或结果数组的元素顺序相对应由 parse方法返回。

setFormatsByArgumentIndex

void setFormatsByArgumentIndex (Format[] newFormats)

设置Format对象以用于传入format方法的值或从parse方法返回的值。 newFormats中元素的newFormats对应于先前设置的模式字符串中使用的参数索引。 因此， newFormats的格式顺序对应于传递给format方法的arguments数组中的元素顺序或format方法返回的结果数组parse 。

如果参数索引用于模式字符串中的多个格式元素，则相应的新格式将用于所有此类格式元素。 如果参数索引不用于模式字符串中的任何格式元素，则忽略相应的新格式。 如果提供的格式少于需要的格式， newFormats.length替换参数索引小于newFormats.length的格式。 只有格式不使用命名参数时才支持此方法，否则会引发IllegalArgumentException。

setFormatsByArgumentName

void setFormatsByArgumentName (Map<String, Format> newFormats)

[icu]将Format对象设置为用于传递给format方法的值或从parse方法返回的值。 newFormats中的键是先前设置的模式字符串中的参数名称，值是格式。

只考虑来自模式字符串的参数名称。 newFormats中与参数名称不对应的额外键将被忽略。 同样，如果参数名称的newFormat中没有格式，则该参数的格式化程序保持不变。

这可以在不使用命名参数的格式上调用。 在这种情况下，将查询表示参数索引的关键字符串的映射，例如“0”，“1”，“2”等。

setLocale

void setLocale (ULocale locale)

设置用于创建参数格式化对象的区域设置。 这会影响对applyPattern方法以及format和formatToCharacterIterator方法的后续调用。

setLocale

void setLocale (Locale locale)

设置用于创建参数格式化对象的区域设置。 这会影响后续对applyPattern方法以及format和formatToCharacterIterator方法的调用。

toPattern

String toPattern ()

返回应用的模式字符串。

usesNamedArguments

boolean usesNamedArguments ()

[icu]如果此MessageFormat使用命名参数，则返回true，否则返回false。 见课程描述。