Moneta (JSR 354 RI) 1.4.5 · org.javamoney.moneta.function.PercentOperator

pack-priv final Class PercentOperator

This class allows to extract the percentage of a MonetaryAmount instance.

Author

Werner Keil

Version

0.5

Field Summary

Modifier and Type	Field and Description
private static final BigDecimal	ONE_HUNDRED
private final BigDecimal	percentValue

Constructor Summary

Access	Constructor and Description
pack-priv	PercentOperator(final BigDecimal decimal) Access the shared instance of `PercentOperator` for use.

Method Summary

Modifier and Type	Method and Description
public MonetaryAmount	Returns: the percent result of the amount, never `null` apply(MonetaryAmount amount) Implements javax.money.MonetaryOperator.apply. Gets the percentage of the amount.
private static BigDecimal	Returns: java.math.BigDecimal calcPercent(BigDecimal java.math.BigDecimal decimal) Calculate a BigDecimal value for a Percent e.g. "3" (3 percent) will generate .03
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

ONE_HUNDRED	back to summary
private static final BigDecimal ONE_HUNDRED

percentValue	back to summary
private final BigDecimal percentValue

Constructor Detail

PercentOperator	back to summary
pack-priv PercentOperator(final BigDecimal decimal) Access the shared instance of `PercentOperator` for use.

Method Detail

apply back to summary

apply	back to summary
public MonetaryAmount apply(MonetaryAmount amount) Implements javax.money.MonetaryOperator.apply. Gets the percentage of the amount. This returns the monetary amount in percent. For example, for 10% 'EUR 2.35' will return 0.235. This is returned as a `MonetaryAmount`. Returns:MonetaryAmount the percent result of the amount, never `null` Annotations @Override

public MonetaryAmount apply(MonetaryAmount amount)

Implements javax.money.MonetaryOperator.apply.

Gets the percentage of the amount.

This returns the monetary amount in percent. For example, for 10% 'EUR 2.35' will return 0.235.

This is returned as a MonetaryAmount.

Returns:MonetaryAmount

the percent result of the amount, never null

Annotations

@Override

calcPercent	back to summary
private static BigDecimal calcPercent(BigDecimal decimal) Calculate a BigDecimal value for a Percent e.g. "3" (3 percent) will generate .03 Parameters decimal:BigDecimal java.math.BigDecimal Returns:BigDecimal java.math.BigDecimal

calcPercent

back to summary

private static BigDecimal calcPercent(BigDecimal decimal)

Calculate a BigDecimal value for a Percent e.g. "3" (3 percent) will generate .03

Parameters

decimal:BigDecimal: java.math.BigDecimal

Returns:BigDecimal

java.math.BigDecimal

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.