com.ibm.icu.text
Enum MessagePattern.Part.Type

java.lang.Object
  java.lang.Enum<MessagePattern.Part.Type>
      com.ibm.icu.text.MessagePattern.Part.Type

All Implemented Interfaces:

Serializable, Comparable<MessagePattern.Part.Type>

Enclosing class:

MessagePattern.Part

public static enum MessagePattern.Part.Type
extends Enum<MessagePattern.Part.Type>

Part type constants.

Status:

Stable ICU 4.8.

Enum Constant Summary

ARG_DOUBLE
A numeric value, for example the offset or an explicit selector value in a PluralFormat style.

ARG_INT
An integer value, for example the offset or an explicit selector value in a PluralFormat style.

ARG_LIMIT
End of an argument.

ARG_NAME
The argument name.

ARG_NUMBER
The argument number, provided by the value.

ARG_SELECTOR
A selector substring in a "complex" argument style.

ARG_START
Start of an argument.

ARG_STYLE
The argument style text.

ARG_TYPE
The argument type.

INSERT_CHAR
Indicates that a syntax character needs to be inserted for auto-quoting.

MSG_LIMIT
End of a message pattern (main or nested).

MSG_START
Start of a message pattern (main or nested).

REPLACE_NUMBER
Indicates a syntactic (non-escaped) # symbol in a plural variant.

SKIP_SYNTAX
Indicates a substring of the pattern string which is to be skipped when formatting.

Method Summary

boolean	hasNumericValue() Indicates whether this part has a numeric value.
static MessagePattern.Part.Type	valueOf(String name) 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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MSG_START

public static final MessagePattern.Part.Type 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.

Status:

Stable ICU 4.8.

MSG_LIMIT

public static final MessagePattern.Part.Type 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.

Status:

Stable ICU 4.8.

SKIP_SYNTAX

public static final MessagePattern.Part.Type 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.

Status:

Stable ICU 4.8.

INSERT_CHAR

public static final MessagePattern.Part.Type 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)

Status:

Stable ICU 4.8.

REPLACE_NUMBER

public static final MessagePattern.Part.Type 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.

Status:

Stable ICU 4.8.

ARG_START

public static final MessagePattern.Part.Type 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.

Status:

Stable ICU 4.8.

ARG_LIMIT

public static final MessagePattern.Part.Type ARG_LIMIT

End of an argument. The length is 1 for the '}'. The value is the ordinal value of the ArgType. Use getArgType().

Status:

Stable ICU 4.8.

ARG_NUMBER

public static final MessagePattern.Part.Type ARG_NUMBER

The argument number, provided by the value.

Status:

Stable ICU 4.8.

ARG_NAME

public static final MessagePattern.Part.Type ARG_NAME

The argument name. The value is undefined and currently always 0.

Status:

Stable ICU 4.8.

ARG_TYPE

public static final MessagePattern.Part.Type ARG_TYPE

The argument type. The value is undefined and currently always 0.

Status:

Stable ICU 4.8.

ARG_STYLE

public static final MessagePattern.Part.Type ARG_STYLE

The argument style text. The value is undefined and currently always 0.

Status:

Stable ICU 4.8.

ARG_SELECTOR

public static final MessagePattern.Part.Type ARG_SELECTOR

A selector substring in a "complex" argument style. The value is undefined and currently always 0.

Status:

Stable ICU 4.8.

ARG_INT

public static final MessagePattern.Part.Type 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.

Status:

Stable ICU 4.8.

ARG_DOUBLE

public static final MessagePattern.Part.Type 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().

Status:

Stable ICU 4.8.

Method Detail

values

public static MessagePattern.Part.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MessagePattern.Part.Type c : MessagePattern.Part.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MessagePattern.Part.Type valueOf(String name)

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 name

NullPointerException - 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 via MessagePattern.getNumericValue(Part).

Returns:

true if this part has a numeric value.

Status:

Stable ICU 4.8.