A Modifier is an object that can be passed through the formatting pipeline until it is finally applied to the string builder. A Modifier usually contains a prefix and a suffix that are applied, but it could contain something else, like a com.ibm.icu.text.SimpleFormatter pattern. A Modifier is usually immutable, except in cases such as MutablePatternModifier, which are mutable for performance reasons.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Modifier.Parameters A fill-in for getParameters().
public static enum	Modifier.Signum

Method Summary

Modifier and Type	Method and Description
public int	Returns: The number of characters (UTF-16 code units) that were added to the string builder. apply(FormattedStringBuilder The string builder to which to apply this modifier. output, int The left index of the string within the builder. Equal to 0 when only one number is being formatted. leftIndex, int The right index of the string within the string builder. Equal to length when only one number is being formatted. rightIndex) Apply this Modifier to the string builder.
public boolean	containsField(Format.Field currency) Whether the modifier contains at least one occurrence of the given field.
public int	getCodePointCount() Returns the number of code points in the modifier, prefix plus suffix.
public Modifier.Parameters	getParameters() Gets a set of "parameters" for this Modifier.
public int	Returns: The number of characters (UTF-16 code units) in the prefix. getPrefixLength() Gets the length of the prefix.
public boolean	Returns: Whether the modifier is strong. isStrong() Whether this modifier is strong.
public 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.

Method Detail

apply	back to summary
public int apply(FormattedStringBuilder output, int leftIndex, int rightIndex) Apply this Modifier to the string builder. Parameters output:FormattedStringBuilder The string builder to which to apply this modifier. leftIndex:int The left index of the string within the builder. Equal to 0 when only one number is being formatted. rightIndex:int The right index of the string within the string builder. Equal to length when only one number is being formatted. Returns:int The number of characters (UTF-16 code units) that were added to the string builder.

apply

back to summary

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

Apply this Modifier to the string builder.

Parameters

output:FormattedStringBuilder: The string builder to which to apply this modifier.
leftIndex:int: The left index of the string within the builder. Equal to 0 when only one number is being formatted.
rightIndex:int: The right index of the string within the string builder. Equal to length when only one number is being formatted.

Returns:int

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

containsField	back to summary
public boolean containsField(Format.Field currency) Whether the modifier contains at least one occurrence of the given field.

getCodePointCount	back to summary
public int getCodePointCount() Returns the number of code points in the modifier, prefix plus suffix.

getParameters	back to summary
public Modifier.Parameters getParameters() Gets a set of "parameters" for this Modifier.

getPrefixLength back to summary

getPrefixLength	back to summary
public int getPrefixLength() Gets the length of the prefix. This information can be used in combination with `apply` to extract the prefix and suffix strings. Returns:int The number of characters (UTF-16 code units) in the prefix.

public int getPrefixLength()

Gets the length of the prefix. This information can be used in combination with apply to extract the prefix and suffix strings.

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

isStrong	back to summary
public boolean isStrong() 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. Returns:boolean Whether the modifier is strong.

isStrong

back to summary

public boolean isStrong()

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.

Returns:boolean: Whether the modifier is strong.

semanticallyEquivalent	back to summary
public 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.

com.ibm.icu.impl.number back to summary

public Class Modifier.Parameters

Class Inheritance

extends Object

java.lang.Object
com.ibm.icu.impl.number.Modifier.Parameters

A fill-in for getParameters(). obj will always be set; if non-null, the other two fields are also safe to read.

Field Summary

Modifier and Type	Field and Description
public ModifierStore	obj
public StandardPlural	plural
public Modifier.Signum	signum

Constructor Summary

Access	Constructor and Description
public	Parameters()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

obj	back to summary
public ModifierStore obj

plural	back to summary
public StandardPlural plural

signum	back to summary
public Modifier.Signum signum

Constructor Detail

Parameters	back to summary
public Parameters()

com.ibm.icu.impl.number back to summary

public final Enum Modifier.Signum

Class Inheritance

extends Enum<Modifier.Signum>

java.lang.Object
java.lang.Enum
com.ibm.icu.impl.number.Modifier.Signum

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	COUNT
public static final Modifier.Signum	NEG
public static final Modifier.Signum	NEG_ZERO
public static final Modifier.Signum	POS
public static final Modifier.Signum	POS_ZERO

Constructor Summary

Access	Constructor and Description
private	Signum()

Method Summary

Modifier and Type	Method and Description
public static Modifier.Signum	valueOf(String name)
public static Modifier.Signum[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COUNT	back to summary
pack-priv static final int COUNT

NEG	back to summary
public static final Modifier.Signum NEG

NEG_ZERO	back to summary
public static final Modifier.Signum NEG_ZERO

POS	back to summary
public static final Modifier.Signum POS

POS_ZERO	back to summary
public static final Modifier.Signum POS_ZERO

Constructor Detail

Signum	back to summary
private Signum()

Method Detail

valueOf	back to summary
public static Modifier.Signum valueOf(String name)

values	back to summary
public static Modifier.Signum[] values()

public Interface Modifier

Nested and Inner Type Summary

Method Summary

Method Detail

public Class Modifier.Parameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Enum Modifier.Signum

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail