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

Class ConstantAffixModifier

java.lang.Object

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

All Implemented Interfaces:

Modifier

public class ConstantAffixModifier
extends Object
implements Modifier

The canonical implementation of Modifier, containing a prefix and suffix string.

Nested Class Summary

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

Modifier.Parameters, Modifier.Signum

Field Summary

Fields

Modifier and Type	Field and Description
static ConstantAffixModifier	EMPTY

Constructor Summary

Constructors

Constructor and Description
ConstantAffixModifier() Constructs a new instance with an empty prefix, suffix, and field.
ConstantAffixModifier(String prefix, String suffix, Format.Field field, boolean strong) Constructs an instance with the given strings.

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.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ConstantAffixModifier EMPTY

Constructor Detail

ConstantAffixModifier

public ConstantAffixModifier(String prefix,
                             String suffix,
                             Format.Field field,
                             boolean strong)

Constructs an instance with the given strings.

The arguments need to be Strings, not CharSequences, because Strings are immutable but CharSequences are not.

Parameters:

prefix - The prefix string.

suffix - The suffix string.

field - The field type to be associated with this modifier. Can be null.

strong - Whether this modifier should be strongly applied.

See Also:

Format.Field

ConstantAffixModifier

public ConstantAffixModifier()

Constructs a new instance with an empty prefix, suffix, and field.

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

toString

public String toString()

Overrides:

toString in class Object