Module dev.metaschema.databind

Package dev.metaschema.databind.model.info

Interface IItemReadHandler

All Known Subinterfaces:

IJsonParsingContext.IInstanceReader

All Known Implementing Classes:

MetaschemaJsonReader

public interface IItemReadHandler

Handler interface for reading bound items during deserialization.

Implementations of this interface handle the reading of different types of model items (flags, fields, assemblies, choice groups).

Method Summary

Modifier and Type	Method	Description
IBoundObject	readChoiceGroupItem(IBoundObject parent, IBoundInstanceModelChoiceGroup instance)	Parse and return an item.
IBoundObject	readItemAssembly(IBoundObject parent, IBoundDefinitionModelAssembly definition)	Parse and return an item.
IBoundObject	readItemAssembly(IBoundObject parent, IBoundInstanceModelAssembly instance)	Parse and return an item.
IBoundObject	readItemAssembly(IBoundObject parent, IBoundInstanceModelGroupedAssembly instance)	Parse and return an item.
IBoundObject	readItemField(IBoundObject parent, IBoundDefinitionModelFieldComplex definition)	Parse and return an item.
IBoundObject	readItemField(IBoundObject parent, IBoundInstanceModelFieldComplex instance)	Parse and return an item.
Object	readItemField(IBoundObject parent, IBoundInstanceModelFieldScalar instance)	Parse and return an item.
IBoundObject	readItemField(IBoundObject parent, IBoundInstanceModelGroupedField instance)	Parse and return an item.
Object	readItemFieldValue(IBoundObject parent, IBoundFieldValue fieldValue)	Parse and return an item.
Object	readItemFlag(IBoundObject parent, IBoundInstanceFlag instance)	Parse and return an item.

Method Details

readItemFlag

@NonNull
Object readItemFlag(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundInstanceFlag instance)
             throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

instance - the flag instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemField

@Nullable
Object readItemField(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundInstanceModelFieldScalar instance)
              throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

instance - the field instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemField

@NonNull
IBoundObject readItemField(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundInstanceModelFieldComplex instance)
                    throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

instance - the field instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemField

@NonNull
IBoundObject readItemField(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundInstanceModelGroupedField instance)
                    throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

instance - the field instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemField

@NonNull
IBoundObject readItemField(@Nullable
 IBoundObject parent,
 @NonNull
 IBoundDefinitionModelFieldComplex definition)
                    throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks, or null if there is no parent

definition - the field instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemFieldValue

@Nullable
Object readItemFieldValue(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundFieldValue fieldValue)
                   throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

fieldValue - the field value instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemAssembly

@NonNull
IBoundObject readItemAssembly(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundInstanceModelAssembly instance)
                       throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

instance - the assembly instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemAssembly

@NonNull
IBoundObject readItemAssembly(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundInstanceModelGroupedAssembly instance)
                       throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

instance - the assembly instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readItemAssembly

@NonNull
IBoundObject readItemAssembly(@Nullable
 IBoundObject parent,
 @NonNull
 IBoundDefinitionModelAssembly definition)
                       throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks, or null if there is no parent

definition - the assembly instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

readChoiceGroupItem

@Nullable
IBoundObject readChoiceGroupItem(@NonNull
 IBoundObject parent,
 @NonNull
 IBoundInstanceModelChoiceGroup instance)
                          throws IOException

Parse and return an item.

Parameters:

parent - the parent Java object to use for serialization callbacks

instance - the choice group instance

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing