Interface Serializer.EncoderContext

All Superinterfaces:
NamingStrategyLocator, PropertyReferenceManager, SerializerLocator
Enclosing interface:
Serializer<T>
public static interface Serializer.EncoderContext extends SerializerLocator, PropertyReferenceManager, NamingStrategyLocator
Context object passes to the Serializer.serialize(Encoder, EncoderContext, Argument, Object) method.
Author:
Jonas Konrad, graemerocher

  • Method Details

    • getConversionService

      default io.micronaut.core.convert.ConversionService getConversionService()
      Returns:
      Conversion service

    • hasView

      default boolean hasView(Class<?>... views)
      Parameters:
      views - Views to check.
      Returns:
      true iff any of the given views is enabled.

    • resolveReference

      @Internal <B,P> @Nullable SerializationReference<B,P> resolveReference(SerializationReference<B,P> reference)
      Resolve a reference for the given type and value.
      Type Parameters:
      B - The bean type
      P - The generic type of the value
      Parameters:
      reference - The reference
      Returns:
      The existing reference, a new one or null if serialization should be skipped

    • getSerdeConfiguration

      default Optional<SerdeConfiguration> getSerdeConfiguration()
      Get the SerdeConfiguration for this context.
      Returns:
      The SerdeConfiguration, or an empty optional if the default should be used
      Since:
      2.7.0

    • getSerializationConfiguration

      default Optional<SerializationConfiguration> getSerializationConfiguration()
      Get the SerializationConfiguration for this context.
      Returns:
      The SerializationConfiguration, or an empty optional if the default should be used
      Since:
      2.7.0

    • getFeatures

      default Set<SerializationConfiguration.Feature> getFeatures()
      Get the active serialization format features for this context.
      Returns:
      The active serialization format features
      Since:
      3.0

    • withFeatures

      default Serializer.EncoderContext withFeatures(Set<SerializationConfiguration.Feature> includedFeatures, Set<SerializationConfiguration.Feature> excludedFeatures)
      Create a context with serialization format features overridden by annotation metadata.
      Parameters:
      includedFeatures - Features to enable
      excludedFeatures - Features to disable
      Returns:
      The derived context
      Since:
      3.0