Package com.ibm.icu.text
Enum MessagePattern.Part.Type
- All Implemented Interfaces:
Serializable
,Comparable<MessagePattern.Part.Type>
,java.lang.constant.Constable
- Enclosing class:
MessagePattern.Part
Part type constants.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA numeric value, for example the offset or an explicit selector value in a PluralFormat style.An integer value, for example the offset or an explicit selector value in a PluralFormat style.End of an argument.The argument name.The argument number, provided by the value.A selector substring in a "complex" argument style.Start of an argument.The argument style text.The argument type.Indicates that a syntax character needs to be inserted for auto-quoting.End of a message pattern (main or nested).Start of a message pattern (main or nested).Indicates a syntactic (non-escaped) # symbol in a plural variant.Indicates a substring of the pattern string which is to be skipped when formatting. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates whether this part has a numeric value.static MessagePattern.Part.Type
Returns the enum constant of this type with the specified name.static MessagePattern.Part.Type[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
MSG_START
Start of a message pattern (main or nested). The length is 0 for the top-level message and for a choice argument sub-message, otherwise 1 for the '{'. The value indicates the nesting level, starting with 0 for the main message.There is always a later MSG_LIMIT part.
-
MSG_LIMIT
End of a message pattern (main or nested). The length is 0 for the top-level message and the last sub-message of a choice argument, otherwise 1 for the '}' or (in a choice argument style) the '|'. The value indicates the nesting level, starting with 0 for the main message. -
SKIP_SYNTAX
Indicates a substring of the pattern string which is to be skipped when formatting. For example, an apostrophe that begins or ends quoted text would be indicated with such a part. The value is undefined and currently always 0. -
INSERT_CHAR
Indicates that a syntax character needs to be inserted for auto-quoting. The length is 0. The value is the character code of the insertion character. (U+0027=APOSTROPHE) -
REPLACE_NUMBER
Indicates a syntactic (non-escaped) # symbol in a plural variant. When formatting, replace this part's substring with the (value-offset) for the plural argument value. The value is undefined and currently always 0. -
ARG_START
Start of an argument. The length is 1 for the '{'. The value is the ordinal value of the ArgType. Use getArgType().This part is followed by either an ARG_NUMBER or ARG_NAME, followed by optional argument sub-parts (see ArgType constants) and finally an ARG_LIMIT part.
-
ARG_LIMIT
End of an argument. The length is 1 for the '}'. The value is the ordinal value of the ArgType. Use getArgType(). -
ARG_NUMBER
The argument number, provided by the value. -
ARG_NAME
The argument name. The value is undefined and currently always 0. -
ARG_TYPE
The argument type. The value is undefined and currently always 0. -
ARG_STYLE
The argument style text. The value is undefined and currently always 0. -
ARG_SELECTOR
A selector substring in a "complex" argument style. The value is undefined and currently always 0. -
ARG_INT
An integer value, for example the offset or an explicit selector value in a PluralFormat style. The part value is the integer value. -
ARG_DOUBLE
A numeric value, for example the offset or an explicit selector value in a PluralFormat style. The part value is an index into an internal array of numeric values; use getNumericValue().
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
hasNumericValue
public boolean hasNumericValue()Indicates whether this part has a numeric value. If so, then that numeric value can be retrieved viaMessagePattern.getNumericValue(Part)
.- Returns:
- true if this part has a numeric value.
-