Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind.model.info

Interface IModelInstanceCollectionInfo<ITEM>

All Known Implementing Classes:

AbstractModelInstanceCollectionInfo

public interface IModelInstanceCollectionInfo<ITEM>

Method Summary

Modifier and Type	Method	Description
Object	deepCopyItems(IBoundObject fromObject, IBoundObject toObject)
Object	emptyValue()
IBoundInstanceModel<ITEM>	getInstance()	Get the associated instance binding for which this info is for.
default Collection<? extends ITEM>	getItemsFromParentInstance(Object parentInstance)
Collection<? extends ITEM>	getItemsFromValue(Object value)
Class<? extends ITEM>	getItemType()	Get the type of the bound object.
boolean	isEmpty(Object value)	Determine if the value is empty.
static <T> IModelInstanceCollectionInfo<T>	of(IBoundInstanceModel<T> instance)
Object	readItems(IModelInstanceReadHandler<ITEM> handler)	Read the value data for the model instance.
int	size(Object value)	Get the number of items associated with the value.
void	writeItems(IModelInstanceWriteHandler<ITEM> handler, Object value)

Method Details

of

@NonNull
static <T> IModelInstanceCollectionInfo<T> of(@NonNull
 IBoundInstanceModel<T> instance)

getInstance

@NonNull
IBoundInstanceModel<ITEM> getInstance()

Get the associated instance binding for which this info is for.

Returns:

the instance binding

size

int size(@Nullable
 Object value)

Get the number of items associated with the value.

Parameters:

value - the value to identify items for

Returns:

the number of items, which will be 0 if value is null

isEmpty

boolean isEmpty(@Nullable
 Object value)

Determine if the value is empty.

Parameters:

value - the value representing a collection

Returns:

true if the value represents a collection with no items or false otherwise

getItemType

@NonNull
Class<? extends ITEM> getItemType()

Get the type of the bound object.

Returns:

the raw type of the bound object

getItemsFromParentInstance

@NonNull
default Collection<? extends ITEM> getItemsFromParentInstance(@NonNull
 Object parentInstance)

getItemsFromValue

@NonNull
Collection<? extends ITEM> getItemsFromValue(Object value)

emptyValue

Object emptyValue()

deepCopyItems

Object deepCopyItems(@NonNull
 IBoundObject fromObject,
 @NonNull
 IBoundObject toObject)
              throws BindingException

Throws:

BindingException

readItems

@Nullable
Object readItems(@NonNull
 IModelInstanceReadHandler<ITEM> handler)
          throws IOException

Read the value data for the model instance.

This method will return a value based on the instance's value type.

Parameters:

handler - the item parsing handler

Returns:

the item collection object or null if the instance is not defined

Throws:

IOException - if there was an error when reading the data

writeItems

void writeItems(@NonNull
 IModelInstanceWriteHandler<ITEM> handler,
 @NonNull
 Object value)
         throws IOException

Throws:

IOException