Package io.micronaut.serde.config

Interface SerdeConfiguration

public interface SerdeConfiguration
Author:
gkrocher

  • Field Details

  • Method Details

    • getDateFormat

      Optional<String> getDateFormat()
      The date format to use when serializing and deserializing dates.
      Returns:
      the date format to use

    • isInetAddressAsNumeric

      default boolean isInetAddressAsNumeric()
      Returns:
      Whether to use InetAddress.getHostAddress() when serializing InetAddress.

    • 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

    • isWriteBinaryAsArray

      @Bindable(defaultValue="true") boolean isWriteBinaryAsArray()
      Control whether to use legacy behavior for writing byte arrays. When set to true (the default in serde 2.x), byte arrays will always be written as arrays of numbers. When set to false, the encoding may be format-specific instead, and will be a base64 string for JSON.
      Returns:
      Whether to use legacy byte array writing behavior

    • 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

    • getMaximumNestingDepth

      @Bindable(defaultValue="1024") int getMaximumNestingDepth()
      The maximum nesting depth for serialization and deserialization.
      Returns:
      The maximum nesting depth for serialization and deserialization
      Since:
      2.0.0

    • getPropertyNamingStrategyName

      @Nullable default @Nullable String getPropertyNamingStrategyName()
      Returns:
      The property naming strategy name
      Since:
      2.10

    • getPropertyNamingStrategy

      @Nullable default @Nullable PropertyNamingStrategy getPropertyNamingStrategy()
      Returns:
      The property naming strategy
      Since:
      2.10

    • isJsonViewEnabled

      default boolean isJsonViewEnabled()
      When true, mappers should respect JsonView annotations on arguments passed to read/write methods.
      Returns:
      Whether to respect view annotations
      Since:
      2.12