Most visited

Recently visited

Results for

Added in API level 24

MessagePattern

public final class MessagePattern
extends Object implements Cloneable, Freezable<MessagePattern>

java.lang.Object
↳	android.icu.text.MessagePattern

Parses and represents ICU MessageFormat patterns. Also handles patterns for ChoiceFormat, PluralFormat and SelectFormat. Used in the implementations of those classes as well as in tools for message validation, translation and format conversion.

The parser handles all syntax relevant for identifying message arguments. This includes "complex" arguments whose style strings contain nested MessageFormat pattern substrings. For "simple" arguments (with no nested MessageFormat pattern substrings), the argument style is not parsed any further.

The parser handles named and numbered message arguments and allows both in one message.

Once a pattern has been parsed successfully, iterate through the parsed data with countParts(), getPart() and related methods.

The data logically represents a parse tree, but is stored and accessed as a list of "parts" for fast and simple parsing and to minimize object allocations. Arguments and nested messages are best handled via recursion. For every _START "part", getLimitPartIndex(int) efficiently returns the index of the corresponding _LIMIT "part".

List of "parts":

 message = MSG_START (SKIP_SYNTAX | INSERT_CHAR | REPLACE_NUMBER | argument)* MSG_LIMIT
 argument = noneArg | simpleArg | complexArg
 complexArg = choiceArg | pluralArg | selectArg

 noneArg = ARG_START.NONE (ARG_NAME | ARG_NUMBER) ARG_LIMIT.NONE
 simpleArg = ARG_START.SIMPLE (ARG_NAME | ARG_NUMBER) ARG_TYPE [ARG_STYLE] ARG_LIMIT.SIMPLE
 choiceArg = ARG_START.CHOICE (ARG_NAME | ARG_NUMBER) choiceStyle ARG_LIMIT.CHOICE
 pluralArg = ARG_START.PLURAL (ARG_NAME | ARG_NUMBER) pluralStyle ARG_LIMIT.PLURAL
 selectArg = ARG_START.SELECT (ARG_NAME | ARG_NUMBER) selectStyle ARG_LIMIT.SELECT

 choiceStyle = ((ARG_INT | ARG_DOUBLE) ARG_SELECTOR message)+
 pluralStyle = [ARG_INT | ARG_DOUBLE] (ARG_SELECTOR [ARG_INT | ARG_DOUBLE] message)+
 selectStyle = (ARG_SELECTOR message)+

Literal output text is not represented directly by "parts" but accessed between parts of a message, from one part's getLimit() to the next part's getIndex().
ARG_START.CHOICE stands for an ARG_START Part with ArgType CHOICE.
In the choiceStyle, the ARG_SELECTOR has the '<', the '#' or the less-than-or-equal-to sign (U+2264).
In the pluralStyle, the first, optional numeric Part has the "offset:" value. The optional numeric Part between each (ARG_SELECTOR, message) pair is the value of an explicit-number selector like "=2", otherwise the selector is a non-numeric identifier.
The REPLACE_NUMBER Part can occur only in an immediate sub-message of the pluralStyle.

This class is not intended for public subclassing.

Summary

Nested classes
`enum`	`MessagePattern.ApostropheMode` Mode for when an apostrophe starts quoted literal text for MessageFormat output.
`enum`	`MessagePattern.ArgType` Argument type constants.
`class`	`MessagePattern.Part` A message pattern "part", representing a pattern parsing event.

Constants
`int`	`ARG_NAME_NOT_NUMBER` Return value from `validateArgumentName(String)` for when the string is a valid "pattern identifier" but not a number.
`int`	`ARG_NAME_NOT_VALID` Return value from `validateArgumentName(String)` for when the string is invalid.
`double`	`NO_NUMERIC_VALUE` Special value that is returned by getNumericValue(Part) when no numeric value is defined for a part.

Public constructors
`MessagePattern()` Constructs an empty MessagePattern with default ApostropheMode.
`MessagePattern(MessagePattern.ApostropheMode mode)` Constructs an empty MessagePattern.
`MessagePattern(String pattern)` Constructs a MessagePattern with default ApostropheMode and parses the MessageFormat pattern string.

Public methods
`String`	`autoQuoteApostropheDeep()` Returns a version of the parsed pattern string where each ASCII apostrophe is doubled (escaped) if it is not already, and if it is not interpreted as quoting syntax.
`void`	`clear()` Clears this MessagePattern.
`void`	`clearPatternAndSetApostropheMode(MessagePattern.ApostropheMode mode)` Clears this MessagePattern and sets the ApostropheMode.
`Object`	`clone()` Creates and returns a copy of this object.
`MessagePattern`	`cloneAsThawed()` Creates and returns an unfrozen copy of this object.
`int`	`countParts()` Returns the number of "parts" created by parsing the pattern string.
`boolean`	`equals(Object other)` Indicates whether some other object is "equal to" this one.
`MessagePattern`	`freeze()` Freezes this object, making it immutable and thread-safe.
`MessagePattern.ApostropheMode`	`getApostropheMode()`
`int`	`getLimitPartIndex(int start)` Returns the index of the ARG\|MSG_LIMIT part corresponding to the ARG\|MSG_START at start.
`double`	`getNumericValue(MessagePattern.Part part)` Returns the numeric value associated with an ARG_INT or ARG_DOUBLE.
`MessagePattern.Part`	`getPart(int i)` Gets the i-th pattern "part".
`MessagePattern.Part.Type`	`getPartType(int i)` Returns the Part.Type of the i-th pattern "part".
`int`	`getPatternIndex(int partIndex)` Returns the pattern index of the specified pattern "part".
`String`	`getPatternString()`
`double`	`getPluralOffset(int pluralStart)` Returns the "offset:" value of a PluralFormat argument, or 0 if none is specified.
`String`	`getSubstring(MessagePattern.Part part)` Returns the substring of the pattern string indicated by the Part.
`boolean`	`hasNamedArguments()` Does the parsed pattern have named arguments like {first_name}?
`boolean`	`hasNumberedArguments()` Does the parsed pattern have numbered arguments like {2}?
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isFrozen()` Determines whether this object is frozen (immutable) or not.
`MessagePattern`	`parse(String pattern)` Parses a MessageFormat pattern string.
`MessagePattern`	`parseChoiceStyle(String pattern)` Parses a ChoiceFormat pattern string.
`MessagePattern`	`parsePluralStyle(String pattern)` Parses a PluralFormat pattern string.
`MessagePattern`	`parseSelectStyle(String pattern)` Parses a SelectFormat pattern string.
`boolean`	`partSubstringMatches(MessagePattern.Part part, String s)` Compares the part's substring with the input string s.
`String`	`toString()` Returns a string representation of the object.
`static int`	`validateArgumentName(String name)` Validates and parses an argument name or argument number string.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.icu.util.Freezable

Constants

ARG_NAME_NOT_NUMBER

Added in API level 24

int ARG_NAME_NOT_NUMBER

Return value from validateArgumentName(String) for when the string is a valid "pattern identifier" but not a number.

Constant Value: -1 (0xffffffff)

ARG_NAME_NOT_VALID

Added in API level 24

int ARG_NAME_NOT_VALID

Return value from validateArgumentName(String) for when the string is invalid. It might not be a valid "pattern identifier", or it have only ASCII digits but there is a leading zero or the number is too large.

Constant Value: -2 (0xfffffffe)

NO_NUMERIC_VALUE

Added in API level 24

double NO_NUMERIC_VALUE

Special value that is returned by getNumericValue(Part) when no numeric value is defined for a part.

See also:

getNumericValue(MessagePattern.Part)

Constant Value: -1.23456789E8

Throws
`IllegalArgumentException`	for syntax errors in the pattern string
`IndexOutOfBoundsException`	if certain limits are exceeded (e.g., argument number too high, argument name too long, etc.)
`NumberFormatException`	if a number could not be parsed

Parameters
`part`	`MessagePattern.Part`: a part of this MessagePattern.
`s`	`String`: a string.

Most visited

Recently visited

Results for

MessagePattern

Summary

Nested classes

Constants

Public constructors

Public methods

Inherited methods

Constants

ARG_NAME_NOT_NUMBER

ARG_NAME_NOT_VALID

NO_NUMERIC_VALUE

Public constructors

MessagePattern

MessagePattern

MessagePattern

Public methods

autoQuoteApostropheDeep

clear

clearPatternAndSetApostropheMode

clone

cloneAsThawed

countParts

equals

freeze

getApostropheMode

getLimitPartIndex

getNumericValue

getPart

getPartType

getPatternIndex

getPatternString

getPluralOffset

getSubstring

hasNamedArguments

hasNumberedArguments

hashCode

isFrozen

parse

parseChoiceStyle

parsePluralStyle

parseSelectStyle

partSubstringMatches

toString

validateArgumentName