Top Fields Constructors Methods
tools.jackson.datatype.javax.money

public final Class JavaxMoneyModule

extends JacksonModule
Class Inheritance
Annotations
@API
status:STABLE
Imports
javax.money.CurrencyUnit, .Monetary, .MonetaryAmount, javax.money.format.MonetaryFormats, org.apiguardian.api.API, tools.jackson.core.Version, tools.jackson.databind.JacksonModule, tools.jackson.databind.module.SimpleDeserializers, .SimpleSerializers

Field Summary

Modifier and TypeField and Description
private final MonetaryAmountFactory<? extends MonetaryAmount>
amountFactory

private final MonetaryAmountFormatFactory
formatFactory

private final FieldNames
names

private final AmountWriter<?>
writer

Constructor Summary

AccessConstructor and Description
public
JavaxMoneyModule()

private <T extends MonetaryAmount>
JavaxMoneyModule(final AmountWriter<?> writer, final FieldNames names, final MonetaryAmountFormatFactory formatFactory, final MonetaryAmountFactory<T> amountFactory)

Method Summary

Modifier and TypeMethod and Description
public String
getModuleName()

Implements abstract tools.jackson.databind.JacksonModule.getModuleName.

Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.

public void
setupModule(final JacksonModule.SetupContext context)

Implements abstract tools.jackson.databind.JacksonModule.setupModule.

Method called by ObjectMapper when module is registered.

public Version
version()

Implements abstract tools.jackson.databind.JacksonModule.version.

Implements tools.jackson.core.Versioned.version.

Method that returns version of this module.

public JavaxMoneyModule
withAmountFieldName(final String name)

public JavaxMoneyModule
withCurrencyFieldName(final String name)

public JavaxMoneyModule
withDecimalNumbers()

public JavaxMoneyModule
withDefaultFormatting()

private JavaxMoneyModule
withFieldNames(final FieldNames names)

public JavaxMoneyModule
withFormattedFieldName(final String name)

public JavaxMoneyModule
withFormatting(final MonetaryAmountFormatFactory formatFactory)

public <T extends MonetaryAmount> JavaxMoneyModule
withMonetaryAmountFactory(final MonetaryAmountFactory<T> amountFactory)

public JavaxMoneyModule
withNumbers(final AmountWriter<?> writer)

public JavaxMoneyModule
withoutFormatting()

public JavaxMoneyModule
withQuotedDecimalNumbers()

Inherited from tools.jackson.databind.JacksonModule:
getDependenciesgetRegistrationId

Field Detail

amountFactoryback to summary
private final MonetaryAmountFactory<? extends MonetaryAmount> amountFactory
formatFactoryback to summary
private final MonetaryAmountFormatFactory formatFactory
namesback to summary
private final FieldNames names
writerback to summary
private final AmountWriter<?> writer

Constructor Detail

JavaxMoneyModuleback to summary
public JavaxMoneyModule()
JavaxMoneyModuleback to summary
private <T extends MonetaryAmount> JavaxMoneyModule(final AmountWriter<?> writer, final FieldNames names, final MonetaryAmountFormatFactory formatFactory, final MonetaryAmountFactory<T> amountFactory)

Method Detail

getModuleNameback to summary
public String getModuleName()

Implements abstract tools.jackson.databind.JacksonModule.getModuleName.

Doc from tools.jackson.databind.JacksonModule.getModuleName.

Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.

Annotations
@Override
setupModuleback to summary
public void setupModule(final JacksonModule.SetupContext context)

Implements abstract tools.jackson.databind.JacksonModule.setupModule.

Doc from tools.jackson.databind.JacksonModule.setupModule.

Method called by ObjectMapper when module is registered. It is called to let module register functionality it provides, using callback methods passed-in context object exposes.

Annotations
@Override
versionback to summary
public Version version()

Implements abstract tools.jackson.databind.JacksonModule.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.databind.JacksonModule.version.

Method that returns version of this module. Can be used by Jackson for informational purposes.

Annotations
@Override
withAmountFieldNameback to summary
public JavaxMoneyModule withAmountFieldName(final String name)
withCurrencyFieldNameback to summary
public JavaxMoneyModule withCurrencyFieldName(final String name)
withDecimalNumbersback to summary
public JavaxMoneyModule withDecimalNumbers()
withDefaultFormattingback to summary
public JavaxMoneyModule withDefaultFormatting()
withFieldNamesback to summary
private JavaxMoneyModule withFieldNames(final FieldNames names)
withFormattedFieldNameback to summary
public JavaxMoneyModule withFormattedFieldName(final String name)
withFormattingback to summary
public JavaxMoneyModule withFormatting(final MonetaryAmountFormatFactory formatFactory)
withMonetaryAmountFactoryback to summary
public <T extends MonetaryAmount> JavaxMoneyModule withMonetaryAmountFactory(final MonetaryAmountFactory<T> amountFactory)
withNumbersback to summary
public JavaxMoneyModule withNumbers(final AmountWriter<?> writer)
Annotations
@API
status:EXPERIMENTAL
withoutFormattingback to summary
public JavaxMoneyModule withoutFormatting()
withQuotedDecimalNumbersback to summary
public JavaxMoneyModule withQuotedDecimalNumbers()