International Components for Unicode for Java (icu4j) 74.2 · com.ibm.icu.text.MultiplierSubstitution

Modifier and Type	Field and Description
pack-priv long	divisor The divisor of the rule that owns this substitution.

Access	Constructor and Description
pack-priv	MultiplierSubstitution(int The substitution's position in its rule's rule text pos, NFRule The rule that owns this substitution rule, NFRuleSet The ruleSet this substitution uses to format its result ruleSet, String The description describing this substitution description) Constructs a MultiplierSubstitution.

Method Summary

Modifier and Type	Method and Description
public double	Returns: The rule's divisor. calcUpperBound(double Ignored. oldUpperBound) Implements abstract com.ibm.icu.text.NFSubstitution.calcUpperBound. Sets the upper bound down to the rule's divisor.
public double	Returns: newRuleValue * divisor composeRuleValue(double The result of matching the substitution newRuleValue, double The base value of the rule containing the substitution oldRuleValue) Implements abstract com.ibm.icu.text.NFSubstitution.composeRuleValue. Returns newRuleValue times the divisor.
public boolean	Returns: true if the two substitutions are functionally equal equals(Object The other substitution that) Overrides com.ibm.icu.text.NFSubstitution.equals. Augments the superclass's equals() function by comparing divisors.
public void	setDivisor(int The radix of the divisor. radix, short The exponent of the divisor. exponent) Overrides com.ibm.icu.text.NFSubstitution.setDivisor. Sets the substitution's divisor based on the values passed in.
pack-priv char	Returns: '<' tokenChar() Implements abstract com.ibm.icu.text.NFSubstitution.tokenChar. The token character for a multiplier substitution is <.
public long	Returns: "number" divided by the rule's divisor transformNumber(long The number being formatted. number) Implements abstract com.ibm.icu.text.NFSubstitution.transformNumber. Divides the number by the rule's divisor and returns the quotient.
public double	Returns: "number" divided by the rule's divisor transformNumber(double The number being formatted number) Implements abstract com.ibm.icu.text.NFSubstitution.transformNumber. Divides the number by the rule's divisor and returns the quotient.

Inherited from com.ibm.icu.text.NFSubstitution:: doParse doSubstitution doSubstitution getPos hashCode isModulusSubstitution makeSubstitution setDecimalFormatSymbols toString

Field Detail

divisor	back to summary
pack-priv long divisor The divisor of the rule that owns this substitution.

Constructor Detail

MultiplierSubstitution	back to summary
pack-priv MultiplierSubstitution(int pos, NFRule rule, NFRuleSet ruleSet, String description) Constructs a MultiplierSubstitution. This uses the superclass constructor to initialize most members, but this substitution also maintains its own copy of its rule's divisor. Parameters pos:int The substitution's position in its rule's rule text rule:NFRule The rule that owns this substitution ruleSet:NFRuleSet The ruleSet this substitution uses to format its result description:String The description describing this substitution

MultiplierSubstitution

back to summary

pack-priv MultiplierSubstitution(int pos, NFRule rule, NFRuleSet ruleSet, String description)

Constructs a MultiplierSubstitution. This uses the superclass constructor to initialize most members, but this substitution also maintains its own copy of its rule's divisor.

Parameters

pos:int: The substitution's position in its rule's rule text
rule:NFRule: The rule that owns this substitution
ruleSet:NFRuleSet: The ruleSet this substitution uses to format its result
description:String: The description describing this substitution

Method Detail

calcUpperBound	back to summary
public double calcUpperBound(double oldUpperBound) Implements abstract com.ibm.icu.text.NFSubstitution.calcUpperBound. Sets the upper bound down to the rule's divisor. Parameters oldUpperBound:double Ignored. Returns:double The rule's divisor. Annotations @Override

calcUpperBound

back to summary

public double calcUpperBound(double oldUpperBound)

Implements abstract com.ibm.icu.text.NFSubstitution.calcUpperBound.

Sets the upper bound down to the rule's divisor.

Parameters

oldUpperBound:double: Ignored.

Returns:double

The rule's divisor.

Annotations

@Override

composeRuleValue	back to summary
public double composeRuleValue(double newRuleValue, double oldRuleValue) Implements abstract com.ibm.icu.text.NFSubstitution.composeRuleValue. Returns newRuleValue times the divisor. Ignores oldRuleValue. (The result of matching a << substitution supersedes the base value of the rule that contains it.) Parameters newRuleValue:double The result of matching the substitution oldRuleValue:double The base value of the rule containing the substitution Returns:double newRuleValue * divisor Annotations @Override

composeRuleValue

back to summary

public double composeRuleValue(double newRuleValue, double oldRuleValue)

Implements abstract com.ibm.icu.text.NFSubstitution.composeRuleValue.

Returns newRuleValue times the divisor. Ignores oldRuleValue. (The result of matching a << substitution supersedes the base value of the rule that contains it.)

Parameters

newRuleValue:double: The result of matching the substitution
oldRuleValue:double: The base value of the rule containing the substitution

Returns:double

newRuleValue * divisor

Annotations

@Override

equals	back to summary
public boolean equals(Object that) Overrides com.ibm.icu.text.NFSubstitution.equals. Augments the superclass's equals() function by comparing divisors. Parameters that:Object The other substitution Returns:boolean true if the two substitutions are functionally equal Annotations @Override

equals

back to summary

public boolean equals(Object that)

Overrides com.ibm.icu.text.NFSubstitution.equals.

Augments the superclass's equals() function by comparing divisors.

Parameters

that:Object: The other substitution

Returns:boolean

true if the two substitutions are functionally equal

Annotations

@Override

setDivisor	back to summary
public void setDivisor(int radix, short exponent) Overrides com.ibm.icu.text.NFSubstitution.setDivisor. Sets the substitution's divisor based on the values passed in. Parameters radix:int The radix of the divisor. exponent:short The exponent of the divisor. Annotations @Override

setDivisor

back to summary

public void setDivisor(int radix, short exponent)

Overrides com.ibm.icu.text.NFSubstitution.setDivisor.

Sets the substitution's divisor based on the values passed in.

Parameters

radix:int: The radix of the divisor.
exponent:short: The exponent of the divisor.

Annotations

@Override

tokenChar	back to summary
pack-priv char tokenChar() Implements abstract com.ibm.icu.text.NFSubstitution.tokenChar. The token character for a multiplier substitution is <. Returns:char '<' Annotations @Override

tokenChar

back to summary

pack-priv char tokenChar()

Implements abstract com.ibm.icu.text.NFSubstitution.tokenChar.

The token character for a multiplier substitution is <.

Returns:char

'<'

Annotations

@Override

transformNumber	back to summary
public long transformNumber(long number) Implements abstract com.ibm.icu.text.NFSubstitution.transformNumber. Divides the number by the rule's divisor and returns the quotient. Parameters number:long The number being formatted. Returns:long "number" divided by the rule's divisor Annotations @Override

transformNumber

back to summary

public long transformNumber(long number)

Implements abstract com.ibm.icu.text.NFSubstitution.transformNumber.

Divides the number by the rule's divisor and returns the quotient.

Parameters

number:long: The number being formatted.

Returns:long

"number" divided by the rule's divisor

Annotations

@Override

transformNumber	back to summary
public double transformNumber(double number) Implements abstract com.ibm.icu.text.NFSubstitution.transformNumber. Divides the number by the rule's divisor and returns the quotient. This is an integral quotient if we're filling in the substitution using another rule set, but it's the full quotient (integral and fractional parts) if we're filling in the substitution using a DecimalFormat. (This allows things such as "1.2 million".) Parameters number:double The number being formatted Returns:double "number" divided by the rule's divisor Annotations @Override

transformNumber

back to summary

public double transformNumber(double number)

Implements abstract com.ibm.icu.text.NFSubstitution.transformNumber.

Divides the number by the rule's divisor and returns the quotient. This is an integral quotient if we're filling in the substitution using another rule set, but it's the full quotient (integral and fractional parts) if we're filling in the substitution using a DecimalFormat. (This allows things such as "1.2 million".)

Parameters

number:double: The number being formatted

Returns:double

"number" divided by the rule's divisor

Annotations

@Override

pack-priv Class MultiplierSubstitution

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail