Package io.micronaut.serde.config

Interface SerdeConfiguration

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

Author:

gkrocher

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()
Optional<TimeZone>	getTimeZone()
boolean	isWriteDatesAsTimestamps()	Whether to write dates as time stamps.

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

isWriteDatesAsTimestamps

@Bindable(defaultValue="true")
boolean isWriteDatesAsTimestamps()

Whether to write dates as time stamps. Defaults to true.

If set to false the default ISO formats will be used to format dates as strings.

Returns:

Whether to write dates as timestamps

See Also:

• DateTimeFormatter

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