Module dev.metaschema.databind

Package dev.metaschema.databind.model.info

Class AbstractModelInstanceWriteHandler<ITEM>

java.lang.Object

dev.metaschema.databind.model.info.AbstractModelInstanceWriteHandler<ITEM>

Type Parameters:

ITEM - the Java type of items being written

All Implemented Interfaces:

IModelInstanceWriteHandler<ITEM>

public abstract class AbstractModelInstanceWriteHandler<ITEM>
extends Object
implements IModelInstanceWriteHandler<ITEM>

An abstract base class for writing model instance collections.

This class provides the framework for writing collections of items during serialization, with support for different collection types.

Constructor Summary

Constructors

Constructor	Description
AbstractModelInstanceWriteHandler(IBoundInstanceModel<ITEM> instance)	Construct a new write handler for the provided model instance.

Method Summary

Modifier and Type	Method	Description
IModelInstanceCollectionInfo<ITEM>	getCollectionInfo()	Get the collection information.
IBoundInstanceModel<ITEM>	getInstance()	Get the associated instance.
void	writeList(List<ITEM> items)	Write items from a list collection.
void	writeMap(Map<String,ITEM> items)	Write items from a map collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.metaschema.databind.model.info.IModelInstanceWriteHandler

writeItem, writeSingleton

Constructor Details

AbstractModelInstanceWriteHandler

public AbstractModelInstanceWriteHandler(@NonNull
 IBoundInstanceModel<ITEM> instance)

Construct a new write handler for the provided model instance.

Parameters:

instance - the model instance to write

Method Details

getInstance

public IBoundInstanceModel<ITEM> getInstance()

Get the associated instance.

Returns:

the instance

getCollectionInfo

@NonNull
public IModelInstanceCollectionInfo<ITEM> getCollectionInfo()

Get the collection information.

Returns:

the info

writeList

public void writeList(List<ITEM> items)
               throws IOException

Description copied from interface: IModelInstanceWriteHandler

Write items from a list collection.

Specified by:

writeList in interface IModelInstanceWriteHandler<ITEM>

Parameters:

items - the list of items to write

Throws:

IOException - if an error occurred while writing the output

writeMap

public void writeMap(Map<String,ITEM> items)
              throws IOException

Description copied from interface: IModelInstanceWriteHandler

Write items from a map collection.

Specified by:

writeMap in interface IModelInstanceWriteHandler<ITEM>

Parameters:

items - the map of items to write, keyed by JSON key flag value

Throws:

IOException - if an error occurred while writing the output