Module gov.nist.secauto.metaschema.databind

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

Interface IBoundNamedInstance

All Superinterfaces:

IInstance, IModelElement, INamedInstance, INamedModelElement

All Known Subinterfaces:

IBoundAssemblyInstance, IBoundFieldInstance, IBoundFieldValueInstance, IBoundFlagInstance, IBoundNamedModelInstance

All Known Implementing Classes:

AbstractFieldProperty

public interface IBoundNamedInstance
extends INamedInstance

Method Summary

Modifier and Type	Method	Description
void	copyBoundObject(Object fromInstance, Object toInstance)	Copy this instance from one parent object to another.
Object	defaultValue()
Field	getField()	Gets the bound Java field associated with this property.
default Class<?>	getItemType()	Get the item type of the bound object.
default String	getJavaFieldName()
default String	getName()
IClassBinding	getParentClassBinding()	Get the IClassBinding for the Java class within which this property exists.
default Map<QName,Set<String>>	getProperties()
default Type	getType()	Get the actual Java type of the underlying bound object.
default Object	getValue(Object parentInstance)	Get the current value from the provided parentInstance object.
default void	setValue(Object parentInstance, Object value)	Set the provided value on the provided object.

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IInstance

getContainingDefinition, getContainingModule, getParentContainer

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelElement

getModelType, getRemarks

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedInstance

getDefinition, getEffectiveDescription, getEffectiveFormalName, getEffectiveName, getXmlNamespace, getXmlQName, toCoordinates

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelElement

getDescription, getFormalName, getJsonName, getPropertyValues, getUseName, hasProperty, hasPropertyValue

Method Detail

getName

default String getName()

Specified by:

getName in interface INamedModelElement

getProperties

@NonNull
default Map<QName,Set<String>> getProperties()

Specified by:

getProperties in interface INamedModelElement

getParentClassBinding

@NonNull
IClassBinding getParentClassBinding()

Get the IClassBinding for the Java class within which this property exists.

Returns:

the containing class's binding

getField

@NonNull
Field getField()

Gets the bound Java field associated with this property.

Returns:

the Java field

getJavaFieldName

@NonNull
default String getJavaFieldName()

getType

@NonNull
default Type getType()

Get the actual Java type of the underlying bound object.

This may be the same as the what is returned by getItemType(), or may be a Java collection class.

Returns:

the raw type of the bound object

getItemType

@NonNull
default Class<?> getItemType()

Get the item type of the bound object. An item type is the primitive or specialized type that represents that data associated with this binding.

Returns:

the item type of the bound object

getValue

default Object getValue(@NonNull
                        Object parentInstance)

Get the current value from the provided parentInstance object. The provided object must be of the type associated with the definition containing this property.

Specified by:

getValue in interface INamedInstance

Parameters:

parentInstance - the object associated with the definition containing this property

Returns:

the value if available, or null otherwise

setValue

default void setValue(@NonNull
                      Object parentInstance,
                      Object value)

Set the provided value on the provided object. The provided object must be of the item's type associated with this property.

Parameters:

parentInstance - the object

value - a value, which may be a simple Type or a ParameterizedType for a collection

defaultValue

@Nullable
Object defaultValue()
             throws BindingException

Throws:

BindingException

copyBoundObject

void copyBoundObject(@NonNull
                     Object fromInstance,
                     @NonNull
                     Object toInstance)
              throws BindingException

Copy this instance from one parent object to another.

Parameters:

fromInstance - the object to copy from

toInstance - the object to copy to

Throws:

BindingException - if an error occurred while processing the object bindings