Package io.micronaut.serde.config

Interface SerdeConfiguration

@ConfigurationProperties("micronaut.serde")
public interface SerdeConfiguration

Author:

gkrocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SerdeConfiguration.NumericTimeUnit	Time unit to use when deserializing a numeric value, or when serializing to a numeric value as configured by getTimeWriteShape().
static enum	SerdeConfiguration.TimeShape	Shape to use for time serialization.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDateFormat()	The date format to use when serializing and deserializing dates.
List<String>	getIncludedIntrospectionPackages()	The packages containing introspections that should be regarded as serializable by default without the need to add the Serdeable annotation.
Optional<Locale>	getLocale()
SerdeConfiguration.NumericTimeUnit	getNumericTimeUnit()	The unit to use for serializing and deserializing dates to or from numbers.
SerdeConfiguration.TimeShape	getTimeWriteShape()	Shape for serializing dates.
Optional<TimeZone>	getTimeZone()

Field Details

PREFIX

static final String PREFIX

See Also:

• Constant Field Values

Method Details

getDateFormat

Optional<String> getDateFormat()

The date format to use when serializing and deserializing dates.

Returns:

the date format to use

getTimeWriteShape

@Bindable(defaultValue="STRING")
SerdeConfiguration.TimeShape getTimeWriteShape()

Shape for serializing dates.

Returns:

The date serialization shape

getNumericTimeUnit

@Bindable(defaultValue="SECONDS")
SerdeConfiguration.NumericTimeUnit getNumericTimeUnit()

The unit to use for serializing and deserializing dates to or from numbers. Note that LocalDate always uses the epoch day, regardless of this setting.

Returns:

The time unit

getLocale

Optional<Locale> getLocale()

Returns:

The default locale to use.

getTimeZone

Optional<TimeZone> getTimeZone()

Returns:

The default time zone to use.

getIncludedIntrospectionPackages

@Bindable(defaultValue="io.micronaut")
List<String> getIncludedIntrospectionPackages()

The packages containing introspections that should be regarded as serializable by default without the need to add the Serdeable annotation.

Returns:

the packages to include