Module dev.metaschema.databind
Package dev.metaschema.databind.io

Class DeserializationFeature<V>

java.lang.Object
dev.metaschema.core.configuration.AbstractConfigurationFeature<V>
dev.metaschema.databind.io.DeserializationFeature<V>
Type Parameters:
V - the value type of the configuration feature
All Implemented Interfaces:
IConfigurationFeature<V>
public final class DeserializationFeature<V> extends AbstractConfigurationFeature<V>
Configuration features that control the deserialization behavior of Metaschema-bound object readers.

Each feature has a default value that can be overridden when configuring a deserializer.

  • Field Details

    • YAML_CODEPOINT_LIMIT_DEFAULT

      public static final int YAML_CODEPOINT_LIMIT_DEFAULT
      The default maximum number of codepoints that can be read from a YAML document.
      See Also:

    • FORMAT_DETECTION_LOOKAHEAD

      public static final int FORMAT_DETECTION_LOOKAHEAD
      The default number of bytes used for format detection lookahead.
      See Also:

    • DESERIALIZE_VALIDATE_CONSTRAINTS

      @NonNull public static final DeserializationFeature<Boolean> DESERIALIZE_VALIDATE_CONSTRAINTS
      If enabled, perform constraint validation on the deserialized bound objects.

    • DESERIALIZE_XML_ALLOW_ENTITY_RESOLUTION

      @NonNull public static final DeserializationFeature<Boolean> DESERIALIZE_XML_ALLOW_ENTITY_RESOLUTION
      If enabled, allow inline XML entities to be automatically replaced.

    • DESERIALIZE_JSON_ROOT_PROPERTY

      @NonNull public static final DeserializationFeature<Boolean> DESERIALIZE_JSON_ROOT_PROPERTY
      If enabled, process the next JSON node as a field, whose name must match the IAssemblyDefinition.getRootJsonName(). If not enabled, the next JSON node is expected to be an object containing the data of the IAssemblyDefinition.

    • YAML_CODEPOINT_LIMIT

      @NonNull public static final DeserializationFeature<Integer> YAML_CODEPOINT_LIMIT
      Determines the max YAML codepoints that can be read.

    • FORMAT_DETECTION_LOOKAHEAD_LIMIT

      @NonNull public static final DeserializationFeature<Integer> FORMAT_DETECTION_LOOKAHEAD_LIMIT
      Determines how many bytes can be looked at to identify the format of a document.

    • DESERIALIZE_VALIDATE_REQUIRED_FIELDS

      @NonNull public static final DeserializationFeature<Boolean> DESERIALIZE_VALIDATE_REQUIRED_FIELDS
      If enabled, validate that required fields are present during deserialization. When a required field is missing and has no default value, an error will be thrown with a descriptive message.

      Choice groups are handled correctly: if an instance belongs to a choice and at least one sibling in that choice was provided, the instance is not considered missing.

      When using schema validation via CLI commands, this feature is automatically disabled since the schema already validates required fields.