Modifier and Type	Class and Description
private static enum	MoneyFormatterBuilder.SingletonPrinters Handles the singleton outputs.
private static enum	MoneyFormatterBuilder.Singletons Handles the singleton outputs.

Modifier and Type	Field and Description
private final List<MoneyParser>	parsers The parsers.
private final List<MoneyPrinter>	printers The printers.

Access	Constructor and Description
public	MoneyFormatterBuilder() Constructor, creating a new empty builder.

Method Summary

Modifier and Type	Method and Description
public MoneyFormatterBuilder	Returns: this for chaining, never null append(MoneyFormatter the formatter to append, not null formatter) Appends the printers and parsers from the specified formatter to this builder.
public MoneyFormatterBuilder	Returns: this for chaining, never null append(MoneyPrinter the printer to append, null makes the formatter unable to print printer, MoneyParser the parser to append, null makes the formatter unable to parse parser) Appends the specified printer and parser to this builder.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendAmount() Appends the amount to the builder using a standard format.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendAmount(MoneyAmountStyle the style to use, not null style) Appends the amount to the builder using the specified amount style.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendAmountLocalized() Appends the amount to the builder using a grouped localized format.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendCurrencyCode() Appends the currency code to the builder.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendCurrencyNumeric3Code() Appends the currency code to the builder.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendCurrencyNumericCode() Appends the currency code to the builder.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendCurrencySymbolLocalized() Appends the localized currency symbol to the builder.
private MoneyFormatterBuilder	Returns: this for chaining, never null appendInternal(MoneyPrinter the printer to append, null makes the formatter unable to print printer, MoneyParser the parser to append, null makes the formatter unable to parse parser) Appends the specified printer and parser to this builder.
public MoneyFormatterBuilder	Returns: this, for chaining, never null appendLiteral(CharSequence the literal to append, null or empty ignored literal) Appends a literal to the builder.
public MoneyFormatterBuilder	Returns: this for chaining, never null appendSigned(MoneyFormatter the formatter to use when the amount is positive or zero whenPositiveOrZero, MoneyFormatter the formatter to use when the amount is negative whenNegative) Appends the specified formatters, one used when the amount is positive, and one when the amount is negative.
public MoneyFormatterBuilder	Returns: this for chaining, never null appendSigned(MoneyFormatter the formatter to use when the amount is positive whenPositive, MoneyFormatter the formatter to use when the amount is zero whenZero, MoneyFormatter the formatter to use when the amount is negative whenNegative) Appends the specified formatters, one used when the amount is positive, one when the amount is zero and one when the amount is negative.
public MoneyFormatter	Returns: the formatter built from this builder, never null toFormatter() Builds the formatter from the builder using the default locale.
public MoneyFormatter	Returns: the formatter built from this builder, never null toFormatter(Locale the initial locale for the formatter, not null locale) Builds the formatter from the builder setting the locale.

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

Field Detail

parsers	back to summary
private final List<MoneyParser> parsers The parsers.

printers	back to summary
private final List<MoneyPrinter> printers The printers.

Constructor Detail

MoneyFormatterBuilder	back to summary
public MoneyFormatterBuilder() Constructor, creating a new empty builder.

Method Detail

append	back to summary
public MoneyFormatterBuilder append(MoneyFormatter formatter) Appends the printers and parsers from the specified formatter to this builder. If the specified formatter cannot print, then the the output of this builder will be unable to print. If the specified formatter cannot parse, then the output of this builder will be unable to parse. Parameters formatter:MoneyFormatter the formatter to append, not null Returns:MoneyFormatterBuilder this for chaining, never null

append

back to summary

public MoneyFormatterBuilder append(MoneyFormatter formatter)

Appends the printers and parsers from the specified formatter to this builder.

If the specified formatter cannot print, then the the output of this builder will be unable to print. If the specified formatter cannot parse, then the output of this builder will be unable to parse.

Parameters

formatter:MoneyFormatter: the formatter to append, not null

Returns:MoneyFormatterBuilder

this for chaining, never null

append	back to summary
public MoneyFormatterBuilder append(MoneyPrinter printer, MoneyParser parser) Appends the specified printer and parser to this builder. If null is specified then the formatter will be unable to print/parse. Parameters printer:MoneyPrinter the printer to append, null makes the formatter unable to print parser:MoneyParser the parser to append, null makes the formatter unable to parse Returns:MoneyFormatterBuilder this for chaining, never null

append

back to summary

public MoneyFormatterBuilder append(MoneyPrinter printer, MoneyParser parser)

Appends the specified printer and parser to this builder.

If null is specified then the formatter will be unable to print/parse.

Parameters

printer:MoneyPrinter: the printer to append, null makes the formatter unable to print
parser:MoneyParser: the parser to append, null makes the formatter unable to parse

Returns:MoneyFormatterBuilder

this for chaining, never null

appendAmount back to summary

appendAmount	back to summary
public MoneyFormatterBuilder appendAmount() Appends the amount to the builder using a standard format. The format used is `MoneyAmountStyle#ASCII_DECIMAL_POINT_GROUP3_COMMA`. The amount is the value itself, such as '12.34'. Returns:MoneyFormatterBuilder this, for chaining, never null

public MoneyFormatterBuilder appendAmount()

Appends the amount to the builder using a standard format.

The format used is MoneyAmountStyle#ASCII_DECIMAL_POINT_GROUP3_COMMA. The amount is the value itself, such as '12.34'.

Returns:MoneyFormatterBuilder: this, for chaining, never null

appendAmount back to summary

appendAmount	back to summary
public MoneyFormatterBuilder appendAmount(MoneyAmountStyle style) Appends the amount to the builder using the specified amount style. The amount is the value itself, such as '12.34'. The amount style allows the formatting of the number to be controlled in detail. This includes the characters for positive, negative, decimal, grouping and whether to output the absolute or signed amount. See `MoneyAmountStyle` for more details. Parameters style:MoneyAmountStyle the style to use, not null Returns:MoneyFormatterBuilder this, for chaining, never null

public MoneyFormatterBuilder appendAmount(MoneyAmountStyle style)

Appends the amount to the builder using the specified amount style.

The amount is the value itself, such as '12.34'.

The amount style allows the formatting of the number to be controlled in detail. This includes the characters for positive, negative, decimal, grouping and whether to output the absolute or signed amount. See MoneyAmountStyle for more details.

Parameters

style:MoneyAmountStyle: the style to use, not null

Returns:MoneyFormatterBuilder

this, for chaining, never null

appendAmountLocalized back to summary

appendAmountLocalized	back to summary
public MoneyFormatterBuilder appendAmountLocalized() Appends the amount to the builder using a grouped localized format. The format used is `MoneyAmountStyle#LOCALIZED_GROUPING`. The amount is the value itself, such as '12.34'. Returns:MoneyFormatterBuilder this, for chaining, never null

public MoneyFormatterBuilder appendAmountLocalized()

Appends the amount to the builder using a grouped localized format.

The format used is MoneyAmountStyle#LOCALIZED_GROUPING. The amount is the value itself, such as '12.34'.

Returns:MoneyFormatterBuilder: this, for chaining, never null

appendCurrencyCode	back to summary
public MoneyFormatterBuilder appendCurrencyCode() Appends the currency code to the builder. The currency code is the three letter ISO code, such as 'GBP'. Returns:MoneyFormatterBuilder this, for chaining, never null

appendCurrencyCode

back to summary

public MoneyFormatterBuilder appendCurrencyCode()

Appends the currency code to the builder.

The currency code is the three letter ISO code, such as 'GBP'.

Returns:MoneyFormatterBuilder: this, for chaining, never null

appendCurrencyNumeric3Code	back to summary
public MoneyFormatterBuilder appendCurrencyNumeric3Code() Appends the currency code to the builder. The numeric code is the ISO numeric code, such as '826' and is zero padded to three digits. Returns:MoneyFormatterBuilder this, for chaining, never null

appendCurrencyNumeric3Code

back to summary

public MoneyFormatterBuilder appendCurrencyNumeric3Code()

Appends the currency code to the builder.

The numeric code is the ISO numeric code, such as '826' and is zero padded to three digits.

Returns:MoneyFormatterBuilder: this, for chaining, never null

appendCurrencyNumericCode	back to summary
public MoneyFormatterBuilder appendCurrencyNumericCode() Appends the currency code to the builder. The numeric code is the ISO numeric code, such as '826'. Returns:MoneyFormatterBuilder this, for chaining, never null

appendCurrencyNumericCode

back to summary

public MoneyFormatterBuilder appendCurrencyNumericCode()

Appends the currency code to the builder.

The numeric code is the ISO numeric code, such as '826'.

Returns:MoneyFormatterBuilder: this, for chaining, never null

appendCurrencySymbolLocalized	back to summary
public MoneyFormatterBuilder appendCurrencySymbolLocalized() Appends the localized currency symbol to the builder. The localized currency symbol is the symbol as chosen by the locale of the formatter. Symbols cannot be parsed. Returns:MoneyFormatterBuilder this, for chaining, never null

appendCurrencySymbolLocalized

back to summary

public MoneyFormatterBuilder appendCurrencySymbolLocalized()

Appends the localized currency symbol to the builder.

The localized currency symbol is the symbol as chosen by the locale of the formatter.

Symbols cannot be parsed.

Returns:MoneyFormatterBuilder: this, for chaining, never null

appendInternal	back to summary
private MoneyFormatterBuilder appendInternal(MoneyPrinter printer, MoneyParser parser) Appends the specified printer and parser to this builder. Either the printer or parser must be non-null. Parameters printer:MoneyPrinter the printer to append, null makes the formatter unable to print parser:MoneyParser the parser to append, null makes the formatter unable to parse Returns:MoneyFormatterBuilder this for chaining, never null

appendInternal

back to summary

private MoneyFormatterBuilder appendInternal(MoneyPrinter printer, MoneyParser parser)

Appends the specified printer and parser to this builder.

Either the printer or parser must be non-null.

Parameters

printer:MoneyPrinter: the printer to append, null makes the formatter unable to print
parser:MoneyParser: the parser to append, null makes the formatter unable to parse

Returns:MoneyFormatterBuilder

this for chaining, never null

appendLiteral	back to summary
public MoneyFormatterBuilder appendLiteral(CharSequence literal) Appends a literal to the builder. The localized currency symbol is the symbol as chosen by the locale of the formatter. Parameters literal:CharSequence the literal to append, null or empty ignored Returns:MoneyFormatterBuilder this, for chaining, never null

appendLiteral

back to summary

public MoneyFormatterBuilder appendLiteral(CharSequence literal)

Appends a literal to the builder.

The localized currency symbol is the symbol as chosen by the locale of the formatter.

Parameters

literal:CharSequence: the literal to append, null or empty ignored

Returns:MoneyFormatterBuilder

this, for chaining, never null

appendSigned back to summary

appendSigned	back to summary
public MoneyFormatterBuilder appendSigned(MoneyFormatter whenPositiveOrZero, MoneyFormatter whenNegative) Appends the specified formatters, one used when the amount is positive, and one when the amount is negative. When printing, the amount is queried and the appropriate formatter is used. When parsing, each formatter is tried, with the longest successful match, or the first match if multiple are successful. If the negative parser is matched, the amount returned will be negative no matter what amount is parsed. A typical use case for this would be to produce a format like '`($123)`' for negative amounts and '`$123`' for positive amounts. In order to use this method, it may be necessary to output an unsigned amount. This can be achieved using `appendAmount(MoneyAmountStyle)` and `MoneyAmountStyle#withAbsValue(boolean)`. Parameters whenPositiveOrZero:MoneyFormatter the formatter to use when the amount is positive or zero whenNegative:MoneyFormatter the formatter to use when the amount is negative Returns:MoneyFormatterBuilder this for chaining, never null

public MoneyFormatterBuilder appendSigned(MoneyFormatter whenPositiveOrZero, MoneyFormatter whenNegative)

Appends the specified formatters, one used when the amount is positive, and one when the amount is negative.

When printing, the amount is queried and the appropriate formatter is used.

When parsing, each formatter is tried, with the longest successful match, or the first match if multiple are successful. If the negative parser is matched, the amount returned will be negative no matter what amount is parsed.

A typical use case for this would be to produce a format like '($123)' for negative amounts and '$123' for positive amounts.

In order to use this method, it may be necessary to output an unsigned amount. This can be achieved using appendAmount(MoneyAmountStyle) and MoneyAmountStyle#withAbsValue(boolean).

Parameters

whenPositiveOrZero:MoneyFormatter: the formatter to use when the amount is positive or zero
whenNegative:MoneyFormatter: the formatter to use when the amount is negative

Returns:MoneyFormatterBuilder

this for chaining, never null

appendSigned back to summary

appendSigned	back to summary
public MoneyFormatterBuilder appendSigned(MoneyFormatter whenPositive, MoneyFormatter whenZero, MoneyFormatter whenNegative) Appends the specified formatters, one used when the amount is positive, one when the amount is zero and one when the amount is negative. When printing, the amount is queried and the appropriate formatter is used. When parsing, each formatter is tried, with the longest successful match, or the first match if multiple are successful. If the zero parser is matched, the amount returned will be zero no matter what amount is parsed. If the negative parser is matched, the amount returned will be negative no matter what amount is parsed. A typical use case for this would be to produce a format like '`($123)`' for negative amounts and '`$123`' for positive amounts. In order to use this method, it may be necessary to output an unsigned amount. This can be achieved using `appendAmount(MoneyAmountStyle)` and `MoneyAmountStyle#withAbsValue(boolean)`. Parameters whenPositive:MoneyFormatter the formatter to use when the amount is positive whenZero:MoneyFormatter the formatter to use when the amount is zero whenNegative:MoneyFormatter the formatter to use when the amount is negative Returns:MoneyFormatterBuilder this for chaining, never null

public MoneyFormatterBuilder appendSigned(MoneyFormatter whenPositive, MoneyFormatter whenZero, MoneyFormatter whenNegative)

Appends the specified formatters, one used when the amount is positive, one when the amount is zero and one when the amount is negative.

When printing, the amount is queried and the appropriate formatter is used.

When parsing, each formatter is tried, with the longest successful match, or the first match if multiple are successful. If the zero parser is matched, the amount returned will be zero no matter what amount is parsed. If the negative parser is matched, the amount returned will be negative no matter what amount is parsed.

A typical use case for this would be to produce a format like '($123)' for negative amounts and '$123' for positive amounts.

In order to use this method, it may be necessary to output an unsigned amount. This can be achieved using appendAmount(MoneyAmountStyle) and MoneyAmountStyle#withAbsValue(boolean).

Parameters

whenPositive:MoneyFormatter: the formatter to use when the amount is positive
whenZero:MoneyFormatter: the formatter to use when the amount is zero
whenNegative:MoneyFormatter: the formatter to use when the amount is negative

Returns:MoneyFormatterBuilder

this for chaining, never null

toFormatter back to summary

toFormatter	back to summary
public MoneyFormatter toFormatter() Builds the formatter from the builder using the default locale. Once the builder is in the correct state it must be converted to a `MoneyFormatter` to be used. Calling this method does not change the state of this instance, so it can still be used. This method uses the default locale within the returned formatter. It can be changed by calling `MoneyFormatter#withLocale(Locale)`. Returns:MoneyFormatter the formatter built from this builder, never null

public MoneyFormatter toFormatter()

Builds the formatter from the builder using the default locale.

Once the builder is in the correct state it must be converted to a MoneyFormatter to be used. Calling this method does not change the state of this instance, so it can still be used.

This method uses the default locale within the returned formatter. It can be changed by calling MoneyFormatter#withLocale(Locale).

Returns:MoneyFormatter: the formatter built from this builder, never null

toFormatter back to summary

toFormatter	back to summary
public MoneyFormatter toFormatter(Locale locale) Builds the formatter from the builder setting the locale. Once the builder is in the correct state it must be converted to a `MoneyFormatter` to be used. Calling this method does not change the state of this instance, so it can still be used. This method uses the specified locale within the returned formatter. It can be changed by calling `MoneyFormatter#withLocale(Locale)`. Parameters locale:Locale the initial locale for the formatter, not null Returns:MoneyFormatter the formatter built from this builder, never null Annotations @SuppressWarnings:cast

public MoneyFormatter toFormatter(Locale locale)

Builds the formatter from the builder setting the locale.

Once the builder is in the correct state it must be converted to a MoneyFormatter to be used. Calling this method does not change the state of this instance, so it can still be used.

This method uses the specified locale within the returned formatter. It can be changed by calling MoneyFormatter#withLocale(Locale).

Parameters

locale:Locale: the initial locale for the formatter, not null

Returns:MoneyFormatter

the formatter built from this builder, never null

Annotations

@SuppressWarnings:cast

org.joda.money.format back to summary

private final Enum MoneyFormatterBuilder.SingletonPrinters

Class Inheritance

extends Enum<MoneyFormatterBuilder.SingletonPrinters>
implements MoneyPrinter

java.lang.Object
java.lang.Enum
org.joda.money.format.MoneyFormatterBuilder.SingletonPrinters

All Implemented Interfaces

org.joda.money.format.MoneyPrinter

Handles the singleton outputs.

Field Summary

Modifier and Type	Field and Description
public static final MoneyFormatterBuilder.SingletonPrinters	LOCALIZED_SYMBOL

Constructor Summary

Access	Constructor and Description
private	SingletonPrinters()

Method Summary

Modifier and Type	Method and Description
public void	print(MoneyPrintContext the context being used, not null context, Appendable the appendable to add to, not null appendable, BigMoney the money to print, not null money) Implements org.joda.money.format.MoneyPrinter.print. Prints part of a monetary value to the output appendable.
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static MoneyFormatterBuilder.SingletonPrinters	valueOf(String name)
public static MoneyFormatterBuilder.SingletonPrinters[]	values()

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

Field Detail

LOCALIZED_SYMBOL	back to summary
public static final MoneyFormatterBuilder.SingletonPrinters LOCALIZED_SYMBOL

Constructor Detail

SingletonPrinters	back to summary
private SingletonPrinters()

Method Detail

print back to summary

print	back to summary
public void print(MoneyPrintContext context, Appendable appendable, BigMoney money) throws IOException Implements org.joda.money.format.MoneyPrinter.print. Doc from org.joda.money.format.MoneyPrinter.print. Prints part of a monetary value to the output appendable. The implementation determines what to append, which may be some or all of the data held in the `BigMoney`. The context is not a thread-safe object and a new instance will be created for each print. The context must not be stored in an instance variable or shared with any other threads. Parameters context:MoneyPrintContext the context being used, not null appendable:Appendable the appendable to add to, not null money:BigMoney the money to print, not null Annotations @Override Exceptions IOException: if an IO exception occurs

public void print(MoneyPrintContext context, Appendable appendable, BigMoney money) throws IOException

Implements org.joda.money.format.MoneyPrinter.print.

Doc from org.joda.money.format.MoneyPrinter.print.

Prints part of a monetary value to the output appendable.

The implementation determines what to append, which may be some or all of the data held in the BigMoney.

The context is not a thread-safe object and a new instance will be created for each print. The context must not be stored in an instance variable or shared with any other threads.

Parameters

context:MoneyPrintContext: the context being used, not null
appendable:Appendable: the appendable to add to, not null
money:BigMoney: the money to print, not null

Annotations

@Override

Exceptions

IOException:: if an IO exception occurs

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static MoneyFormatterBuilder.SingletonPrinters valueOf(String name)

values	back to summary
public static MoneyFormatterBuilder.SingletonPrinters[] values()

org.joda.money.format back to summary

private sealed Enum MoneyFormatterBuilder.Singletons

Class Inheritance

extends Enum<MoneyFormatterBuilder.Singletons>
implements MoneyPrinter, MoneyParser

java.lang.Object
java.lang.Enum
org.joda.money.format.MoneyFormatterBuilder.Singletons

All Implemented Interfaces

org.joda.money.format.MoneyParser, org.joda.money.format.MoneyPrinter

Handles the singleton outputs.

Field Summary

Modifier and Type	Field and Description
public static final MoneyFormatterBuilder.Singletons	CODE
public static final MoneyFormatterBuilder.Singletons	NUMERIC_3_CODE
public static final MoneyFormatterBuilder.Singletons	NUMERIC_CODE
private final String	toString

Constructor Summary

Access	Constructor and Description
private	Singletons(String toString)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static MoneyFormatterBuilder.Singletons	valueOf(String name)
public static MoneyFormatterBuilder.Singletons[]	values()

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

Field Detail

CODE	back to summary
public static final MoneyFormatterBuilder.Singletons CODE

NUMERIC_3_CODE	back to summary
public static final MoneyFormatterBuilder.Singletons NUMERIC_3_CODE

NUMERIC_CODE	back to summary
public static final MoneyFormatterBuilder.Singletons NUMERIC_CODE

toString	back to summary
private final String toString

Constructor Detail

Singletons	back to summary
private Singletons(String toString)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static MoneyFormatterBuilder.Singletons valueOf(String name)

values	back to summary
public static MoneyFormatterBuilder.Singletons[] values()

public final Class MoneyFormatterBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum MoneyFormatterBuilder.SingletonPrinters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private sealed Enum MoneyFormatterBuilder.Singletons

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail