Moneta (JSR 354 RI) 1.4.5 · org.javamoney.moneta.spi.format.CurrencyToken

Modifier and Type	Field and Description
private final AmountFormatContext	context The current conversion context.
private final Locale	locale The target locale.
private CurrencyStyle	style The style defining, how the currency should be localized.

Access	Constructor and Description
pack-priv	CurrencyToken(CurrencyStyle The style defining, how the currency should be localized, not `null`. style, AmountFormatContext The target context, not `null`. context) Creates a new `CurrencyToken`.

Method Summary

Modifier and Type	Method and Description
private Currency	Returns: the corresponding currency instance, or null. getCurrency(String the currency code , not null. currencyCode) Method to safely access a `java.util.Currency`.
private String	Returns: the formatted currency name. getCurrencyName(CurrencyUnit The currency, not `null` currency) This method tries to evaluate the localized display name for a `CurrencyUnit`.
public CurrencyStyle	Returns: the current `CurrencyStyle`, never `null`. getCurrencyStyle() Access the `CurrencyStyle` used for formatting.
private String	Returns: the formatted currency symbol. getCurrencySymbol(CurrencyUnit The currency, not `null` currency) This method tries to evaluate the localized symbol name for a `CurrencyUnit`.
private String	Returns: the formatted currency. getToken(MonetaryAmount the `MonetaryAmount` containing the `CurrencyUnit` to be formatted. amount) Evaluate the formatted(localized) token.
public void	parse(ParseContext context) Implements org.javamoney.moneta.spi.format.FormatToken.parse. Parses a currency from the given `ParseContext`.
private String	Returns: the first letter based part, or the full token. parseCurrencyCode(String the input token token) Tries to split up a letter based first part, e.g. for evaluating a ISO currency code from an input as 'CHF100.34'.
public void	print(Appendable appendable, MonetaryAmount amount) Implements org.javamoney.moneta.spi.format.FormatToken.print. Prints the `CurrencyUnit` of the given `MonetaryAmount` to the given `Appendable`.
public CurrencyToken	Returns: this token instance, for chaining. setCurrencyStyle(CurrencyStyle the `CurrencyStyle`, not `null`. style) Explicitly configure the `CurrencyStyle` to be used.
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

context	back to summary
private final AmountFormatContext context The current conversion context.

locale	back to summary
private final Locale locale The target locale.

style	back to summary
private CurrencyStyle style The style defining, how the currency should be localized.

CurrencyToken	back to summary
pack-priv CurrencyToken(CurrencyStyle style, AmountFormatContext context) Creates a new `CurrencyToken`. Parameters style:CurrencyStyle The style defining, how the currency should be localized, not `null`. context:AmountFormatContext The target context, not `null`.

Method Detail

getCurrency back to summary

getCurrency	back to summary
private Currency getCurrency(String currencyCode) Method to safely access a `java.util.Currency`. If no such currency exists, null is returned. Parameters currencyCode:String the currency code , not null. Returns:Currency the corresponding currency instance, or null.

private Currency getCurrency(String currencyCode)

Method to safely access a java.util.Currency. If no such currency exists, null is returned.

Parameters

currencyCode:String: the currency code , not null.

Returns:Currency

the corresponding currency instance, or null.

getCurrencyName back to summary

getCurrencyName	back to summary
private String getCurrencyName(CurrencyUnit currency) This method tries to evaluate the localized display name for a `CurrencyUnit`. It uses `Currency#getDisplayName(Locale)` if the given currency code maps to a JDK `Currency` instance. If not found `currency.getCurrencyCode()` is returned. Parameters currency:CurrencyUnit The currency, not `null` Returns:String the formatted currency name.

private String getCurrencyName(CurrencyUnit currency)

This method tries to evaluate the localized display name for a CurrencyUnit. It uses Currency#getDisplayName(Locale) if the given currency code maps to a JDK Currency instance.

If not found currency.getCurrencyCode() is returned.

Parameters

currency:CurrencyUnit: The currency, not null

Returns:String

the formatted currency name.

getCurrencyStyle back to summary

getCurrencyStyle	back to summary
public CurrencyStyle getCurrencyStyle() Access the `CurrencyStyle` used for formatting. Returns:CurrencyStyle the current `CurrencyStyle`, never `null`.

public CurrencyStyle getCurrencyStyle()

Access the CurrencyStyle used for formatting.

Returns:CurrencyStyle: the current CurrencyStyle, never null.

getCurrencySymbol back to summary

getCurrencySymbol	back to summary
private String getCurrencySymbol(CurrencyUnit currency) This method tries to evaluate the localized symbol name for a `CurrencyUnit`. It uses `Currency#getSymbol(Locale)` if the given currency code maps to a JDK `Currency` instance. If not found `currency.getCurrencyCode()` is returned. Parameters currency:CurrencyUnit The currency, not `null` Returns:String the formatted currency symbol.

private String getCurrencySymbol(CurrencyUnit currency)

This method tries to evaluate the localized symbol name for a CurrencyUnit. It uses Currency#getSymbol(Locale) if the given currency code maps to a JDK Currency instance.

If not found currency.getCurrencyCode() is returned.

Parameters

currency:CurrencyUnit: The currency, not null

Returns:String

the formatted currency symbol.

getToken back to summary

getToken	back to summary
private String getToken(MonetaryAmount amount) Evaluate the formatted(localized) token. Parameters amount:MonetaryAmount the `MonetaryAmount` containing the `CurrencyUnit` to be formatted. Returns:String the formatted currency.

private String getToken(MonetaryAmount amount)

Evaluate the formatted(localized) token.

Parameters

amount:MonetaryAmount: the MonetaryAmount containing the CurrencyUnit to be formatted.

Returns:String

the formatted currency.

parse back to summary

parse	back to summary
public void parse(ParseContext context) throws MonetaryParseException Implements org.javamoney.moneta.spi.format.FormatToken.parse. Parses a currency from the given `ParseContext`. Depending on the current `CurrencyStyle` it interprets the next non empty token, either as currency code currency symbol Parsing of localized currency names or numeric code is not supported. Annotations @Override Exceptions MonetaryParseException: on an error or if the `CurrencyStyle` is configured to non implemented currency name (NAME), or numeric codes (NUMERIC_CODE).

public void parse(ParseContext context) throws MonetaryParseException

Implements org.javamoney.moneta.spi.format.FormatToken.parse.

Parses a currency from the given ParseContext. Depending on the current CurrencyStyle it interprets the next non empty token, either as

currency code
currency symbol

Parsing of localized currency names or numeric code is not supported.

Annotations

@Override

Exceptions

MonetaryParseException:: on an error or if the CurrencyStyle is configured to non implemented currency name (NAME), or numeric codes (NUMERIC_CODE).

parseCurrencyCode	back to summary
private String parseCurrencyCode(String token) Tries to split up a letter based first part, e.g. for evaluating a ISO currency code from an input as 'CHF100.34'. Parameters token:String the input token Returns:String the first letter based part, or the full token.

parseCurrencyCode

back to summary

private String parseCurrencyCode(String token)

Tries to split up a letter based first part, e.g. for evaluating a ISO currency code from an input as 'CHF100.34'.

Parameters

token:String: the input token

Returns:String

the first letter based part, or the full token.

print back to summary

print	back to summary
public void print(Appendable appendable, MonetaryAmount amount) throws IOException Implements org.javamoney.moneta.spi.format.FormatToken.print. Prints the `CurrencyUnit` of the given `MonetaryAmount` to the given `Appendable`. Annotations @Override Exceptions IOException: may be thrown by the `Appendable`

public void print(Appendable appendable, MonetaryAmount amount) throws IOException

Implements org.javamoney.moneta.spi.format.FormatToken.print.

Prints the CurrencyUnit of the given MonetaryAmount to the given Appendable.

Annotations

@Override

Exceptions

IOException:: may be thrown by the Appendable

setCurrencyStyle back to summary

setCurrencyStyle	back to summary
public CurrencyToken setCurrencyStyle(CurrencyStyle style) Explicitly configure the `CurrencyStyle` to be used. Parameters style:CurrencyStyle the `CurrencyStyle`, not `null`. Returns:CurrencyToken this token instance, for chaining.

public CurrencyToken setCurrencyStyle(CurrencyStyle style)

Explicitly configure the CurrencyStyle to be used.

Parameters

style:CurrencyStyle: the CurrencyStyle, not null.

Returns:CurrencyToken

this token instance, for chaining.

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.

Annotations

@Override

pack-priv final Class CurrencyToken

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail