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:

dev.metaschema.core.configuration.IConfigurationFeature<V>

public final class DeserializationFeature<V>
extends dev.metaschema.core.configuration.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 Summary

Fields

Modifier and Type	Field	Description
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().
static final DeserializationFeature<Boolean>	DESERIALIZE_VALIDATE_CONSTRAINTS	If enabled, perform constraint validation on the deserialized bound objects.
static final DeserializationFeature<Boolean>	DESERIALIZE_VALIDATE_REQUIRED_FIELDS	If enabled, validate that required fields are present during deserialization.
static final DeserializationFeature<Boolean>	DESERIALIZE_XML_ALLOW_ENTITY_RESOLUTION	If enabled, allow inline XML entities to be automatically replaced.
static final int	FORMAT_DETECTION_LOOKAHEAD	The default number of bytes used for format detection lookahead.
static final DeserializationFeature<Integer>	FORMAT_DETECTION_LOOKAHEAD_LIMIT	Determines how many bytes can be looked at to identify the format of a document.
static final DeserializationFeature<Integer>	YAML_CODEPOINT_LIMIT	Determines the max YAML codepoints that can be read.
static final int	YAML_CODEPOINT_LIMIT_DEFAULT	The default maximum number of codepoints that can be read from a YAML document.

Method Summary

Methods inherited from class dev.metaschema.core.configuration.AbstractConfigurationFeature

getDefault, getName, getValueClass, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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:

• Constant Field Values

FORMAT_DETECTION_LOOKAHEAD

public static final int FORMAT_DETECTION_LOOKAHEAD

The default number of bytes used for format detection lookahead.

See Also:

• Constant Field Values

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.