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

pack-priv final Class PermilOperator

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

Authors

Anatole Tresch, Werner Keil

Version

0.5

Field Summary

Modifier and Type	Field and Description
private static final MathContext	DEFAULT_MATH_CONTEXT
private static final BigDecimal	ONE_THOUSAND
private final BigDecimal	permilValue

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public MonetaryAmount	Returns: the permil result of the amount, never `null` apply(MonetaryAmount amount) Implements javax.money.MonetaryOperator.apply. Gets the permil of the amount.
private static BigDecimal	Returns: java.math.BigDecimal calcPermil(BigDecimal java.math.BigDecimal decimal) Calculate a BigDecimal value for a Permil e.g. "3" (3 permil) will generate .003
private static MathContext	Returns: the `MathContext` to be used, by default `MathContext#DECIMAL64`. initDefaultMathContext() Get `MathContext` for `PermilOperator` instances.
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

DEFAULT_MATH_CONTEXT	back to summary
private static final MathContext DEFAULT_MATH_CONTEXT

ONE_THOUSAND	back to summary
private static final BigDecimal ONE_THOUSAND

permilValue	back to summary
private final BigDecimal permilValue

Constructor Detail

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

Method Detail

apply back to summary

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

public MonetaryAmount apply(MonetaryAmount amount)

Implements javax.money.MonetaryOperator.apply.

Gets the permil of the amount.

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

This is returned as a MonetaryAmount.

Returns:MonetaryAmount

the permil result of the amount, never null

Annotations

@Override

calcPermil	back to summary
private static BigDecimal calcPermil(BigDecimal decimal) Calculate a BigDecimal value for a Permil e.g. "3" (3 permil) will generate .003 Parameters decimal:BigDecimal java.math.BigDecimal Returns:BigDecimal java.math.BigDecimal

calcPermil

back to summary

private static BigDecimal calcPermil(BigDecimal decimal)

Calculate a BigDecimal value for a Permil e.g. "3" (3 permil) will generate .003

Parameters

decimal:BigDecimal: java.math.BigDecimal

Returns:BigDecimal

java.math.BigDecimal

initDefaultMathContext back to summary

initDefaultMathContext	back to summary
private static MathContext initDefaultMathContext() Get `MathContext` for `PermilOperator` instances. Returns:MathContext the `MathContext` to be used, by default `MathContext#DECIMAL64`.

private static MathContext initDefaultMathContext()

Get MathContext for PermilOperator instances.

Returns:MathContext: the MathContext to be used, by default MathContext#DECIMAL64.

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.