org.graalvm.shadowed.com.ibm.icu.impl.number

Class SimpleModifier

java.lang.Object

org.graalvm.shadowed.com.ibm.icu.impl.number.SimpleModifier

All Implemented Interfaces:

Modifier

public class SimpleModifier
extends Object
implements Modifier

The second primary implementation of Modifier, this one consuming a SimpleFormatter pattern.

Nested Class Summary

Nested classes/interfaces inherited from interface org.graalvm.shadowed.com.ibm.icu.impl.number.Modifier

Modifier.Parameters, Modifier.Signum

Constructor Summary

Constructors

Constructor and Description
SimpleModifier(String compiledPattern, Format.Field field, boolean strong) Creates a modifier that uses the SimpleFormatter string formats.
SimpleModifier(String compiledPattern, Format.Field field, boolean strong, Modifier.Parameters parameters) Creates a modifier that uses the SimpleFormatter string formats.

Method Summary

Modifier and Type	Method and Description
int	apply(FormattedStringBuilder output, int leftIndex, int rightIndex) Apply this Modifier to the string builder.
boolean	containsField(Format.Field field) Whether the modifier contains at least one occurrence of the given field.
static void	formatTwoArgPattern(String compiledPattern, FormattedStringBuilder result, int index, PrefixInfixSuffixLengthHelper h, Format.Field field) TODO: Like above, this belongs with the rest of the SimpleFormatterImpl code.
int	getCodePointCount() Returns the number of code points in the modifier, prefix plus suffix.
Modifier.Parameters	getParameters() Gets a set of "parameters" for this Modifier.
int	getPrefixLength() Gets the length of the prefix.
boolean	isStrong() Whether this modifier is strong.
boolean	semanticallyEquivalent(Modifier other) Returns whether this Modifier is *semantically equivalent* to the other Modifier; in many cases, this is the same as equal, but parameters should be ignored.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleModifier

public SimpleModifier(String compiledPattern,
                      Format.Field field,
                      boolean strong)

Creates a modifier that uses the SimpleFormatter string formats.

SimpleModifier

public SimpleModifier(String compiledPattern,
                      Format.Field field,
                      boolean strong,
                      Modifier.Parameters parameters)

Creates a modifier that uses the SimpleFormatter string formats.

Method Detail

apply

public int apply(FormattedStringBuilder output,
                 int leftIndex,
                 int rightIndex)

Description copied from interface: Modifier

Apply this Modifier to the string builder.

Specified by:

apply in interface Modifier

Parameters:

output - The string builder to which to apply this modifier.

leftIndex - The left index of the string within the builder. Equal to 0 when only one number is being formatted.

rightIndex - The right index of the string within the string builder. Equal to length when only one number is being formatted.

Returns:

The number of characters (UTF-16 code units) that were added to the string builder.

getPrefixLength

public int getPrefixLength()

Description copied from interface: Modifier

Gets the length of the prefix. This information can be used in combination with Modifier.apply(org.graalvm.shadowed.com.ibm.icu.impl.FormattedStringBuilder, int, int) to extract the prefix and suffix strings.

Specified by:

getPrefixLength in interface Modifier

Returns:

The number of characters (UTF-16 code units) in the prefix.

getCodePointCount

public int getCodePointCount()

Description copied from interface: Modifier

Returns the number of code points in the modifier, prefix plus suffix.

Specified by:

getCodePointCount in interface Modifier

isStrong

public boolean isStrong()

Description copied from interface: Modifier

Whether this modifier is strong. If a modifier is strong, it should always be applied immediately and not allowed to bubble up. With regard to padding, strong modifiers are considered to be on the inside of the prefix and suffix.

Specified by:

isStrong in interface Modifier

Returns:

Whether the modifier is strong.

containsField

public boolean containsField(Format.Field field)

Description copied from interface: Modifier

Whether the modifier contains at least one occurrence of the given field.

Specified by:

containsField in interface Modifier

getParameters

public Modifier.Parameters getParameters()

Description copied from interface: Modifier

Gets a set of "parameters" for this Modifier.

Specified by:

getParameters in interface Modifier

semanticallyEquivalent

public boolean semanticallyEquivalent(Modifier other)

Description copied from interface: Modifier

Returns whether this Modifier is *semantically equivalent* to the other Modifier; in many cases, this is the same as equal, but parameters should be ignored.

Specified by:

semanticallyEquivalent in interface Modifier

formatTwoArgPattern

public static void formatTwoArgPattern(String compiledPattern,
                                       FormattedStringBuilder result,
                                       int index,
                                       PrefixInfixSuffixLengthHelper h,
                                       Format.Field field)

TODO: Like above, this belongs with the rest of the SimpleFormatterImpl code. I put it here so that the SimpleFormatter uses in FormattedStringBuilder are near each other.

Applies the compiled two-argument pattern to the FormattedStringBuilder.

This method is optimized for the case where the prefix and suffix are often empty, such as in the range pattern like "{0}-{1}".