Module gov.nist.secauto.metaschema.databind

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

Class DefaultAssemblyClassBinding

java.lang.Object

gov.nist.secauto.metaschema.databind.model.DefaultAssemblyClassBinding

All Implemented Interfaces:

IConstrained, IModelConstrained, gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained, gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained, IValueConstrained, IAssembly, IAssemblyDefinition, IContainer, IDefinition, IFeatureFlagContainer<IBoundFlagInstance>, IFeatureModelContainer<IBoundNamedModelInstance,IBoundNamedModelInstance,IBoundFieldInstance,IBoundAssemblyInstance,IChoiceInstance>, IFlagContainer, IModelContainer, IModelElement, INamedModelElement, IAssemblyClassBinding, IClassBinding

public class DefaultAssemblyClassBinding
extends Object
implements IAssemblyClassBinding

Field Summary

Fields inherited from interface gov.nist.secauto.metaschema.core.model.IDefinition

DEFAULT_DEFINITION_MODEL_SCOPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultAssemblyClassBinding(Class<?> clazz, IBindingContext bindingContext)	Construct a new IClassBinding for a Java bean annotated with the BoundAssembly annotation.

Method Summary

Modifier and Type	Method	Description
void	callAfterDeserialize(Object targetObject, Object parentObject)	Calls the method named "afterDeserialize" on each class in the object's hierarchy if the method exists.
void	callBeforeDeserialize(Object targetObject, Object parentObject)	Calls the method named "beforeDeserialize" on each class in the object's hierarchy if the method exists on the class.
Object	copyBoundObject(Object item, Object parentInstance)	Create a deep copy of the provided bound object.
protected void	copyBoundObjectInternal(Object fromInstance, Object toInstance)
static DefaultAssemblyClassBinding	createInstance(Class<?> clazz, IBindingContext bindingContext)	Create a new IClassBinding for a Java bean annotated with the BoundAssembly annotation.
IBindingContext	getBindingContext()
Class<?>	getBoundClass()	The class this binding is for.
IModelConstrained	getConstraintSupport()
IModule	getContainingModule()
MarkupLine	getDescription()
IFlagContainerSupport<IBoundFlagInstance>	getFlagContainer()
String	getFormalName()
IBoundAssemblyInstance	getInlineInstance()
IModelContainerSupport<IBoundNamedModelInstance,IBoundNamedModelInstance,IBoundFieldInstance,IBoundAssemblyInstance,IChoiceInstance>	getModelContainer()
protected Class<? extends IModule>	getModuleClass()
ModuleScopeEnum	getModuleScope()
String	getName()
MarkupMultiline	getRemarks()
String	getRootName()
QName	getRootXmlQName()
String	getUseName()
protected IModule	initModule()
boolean	isInline()
boolean	isRoot()
<CLASS> CLASS	newInstance()	Gets a new instance of the bound class.
String	toCoordinates()

Methods inherited from class java.lang.Object

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

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

getModelType

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IAssemblyClassBinding

getOwningDefinition, getProperties

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

getRootJsonName, isSimple

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IClassBinding

callAfterDeserialize, callBeforeDeserialize, copyBoundObject, getBindingContext, getBoundClass, newInstance

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

getModuleScope, toCoordinates

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

getFlagInstanceByName, getFlagInstances, getJsonKeyFlagInstance

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained

addConstraint, addConstraint, addConstraint, getHasCardinalityConstraints, getIndexConstraints, getUniqueConstraints

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

getAssemblyInstanceByName, getAssemblyInstances, getChoiceInstances, getFieldInstanceByName, getFieldInstances, getModelInstanceByName, getModelInstances, getNamedModelInstances

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained

addConstraint, addConstraint, addConstraint, addConstraint, getAllowedValuesConstraints, getConstraints, getExpectConstraints, getIndexHasKeyConstraints, getMatchesConstraints

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

hasJsonKey

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

getContainingModule

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

getEffectiveDescription, getEffectiveFormalName, getEffectiveName, getJsonName, getPropertyValues, getUseName, hasProperty, hasPropertyValue

Constructor Detail

DefaultAssemblyClassBinding

protected DefaultAssemblyClassBinding(@NonNull
                                      Class<?> clazz,
                                      @NonNull
                                      IBindingContext bindingContext)

Construct a new IClassBinding for a Java bean annotated with the BoundAssembly annotation.

Parameters:

clazz - the Java bean class

bindingContext - the class binding context for which this class is participating

Method Detail

createInstance

@NonNull
public static DefaultAssemblyClassBinding createInstance(@NonNull
                                                         Class<?> clazz,
                                                         @NonNull
                                                         IBindingContext bindingContext)

Create a new IClassBinding for a Java bean annotated with the BoundAssembly annotation.

Parameters:

clazz - the Java bean class

bindingContext - information about how Java classes are bound to Module definitions

Returns:

the Module assembly binding for the class

getFlagContainer

public IFlagContainerSupport<IBoundFlagInstance> getFlagContainer()

Specified by:

getFlagContainer in interface IFeatureFlagContainer<IBoundFlagInstance>

getModelContainer

public IModelContainerSupport<IBoundNamedModelInstance,IBoundNamedModelInstance,IBoundFieldInstance,IBoundAssemblyInstance,IChoiceInstance> getModelContainer()

Specified by:

getModelContainer in interface IFeatureModelContainer<IBoundNamedModelInstance,IBoundNamedModelInstance,IBoundFieldInstance,IBoundAssemblyInstance,IChoiceInstance>

getFormalName

public String getFormalName()

Specified by:

getFormalName in interface INamedModelElement

getDescription

public MarkupLine getDescription()

Specified by:

getDescription in interface INamedModelElement

getRemarks

@Nullable
public MarkupMultiline getRemarks()

Specified by:

getRemarks in interface IModelElement

getName

public String getName()

Specified by:

getName in interface INamedModelElement

isInline

public boolean isInline()

Specified by:

isInline in interface IDefinition

getInlineInstance

public IBoundAssemblyInstance getInlineInstance()

Specified by:

getInlineInstance in interface IAssemblyDefinition

Specified by:

getInlineInstance in interface IDefinition

Specified by:

getInlineInstance in interface IFlagContainer

isRoot

public boolean isRoot()

Specified by:

isRoot in interface IAssemblyDefinition

getRootName

public String getRootName()

Specified by:

getRootName in interface IAssemblyDefinition

getRootXmlQName

public QName getRootXmlQName()

Specified by:

getRootXmlQName in interface IAssemblyDefinition

getConstraintSupport

public IModelConstrained getConstraintSupport()

Specified by:

getConstraintSupport in interface gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained

Specified by:

getConstraintSupport in interface gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained

copyBoundObjectInternal

protected void copyBoundObjectInternal(@NonNull
                                       Object fromInstance,
                                       @NonNull
                                       Object toInstance)
                                throws BindingException

Throws:

BindingException

getModuleClass

protected Class<? extends IModule> getModuleClass()

getBoundClass

public Class<?> getBoundClass()

Description copied from interface: IClassBinding

The class this binding is for.

Specified by:

getBoundClass in interface IClassBinding

Returns:

the bound class

getBindingContext

public IBindingContext getBindingContext()

Specified by:

getBindingContext in interface IClassBinding

getUseName

public String getUseName()

Specified by:

getUseName in interface INamedModelElement

toCoordinates

public String toCoordinates()

Specified by:

toCoordinates in interface IDefinition

Specified by:

toCoordinates in interface IModelElement

getModuleScope

@NonNull
public ModuleScopeEnum getModuleScope()

Specified by:

getModuleScope in interface IDefinition

initModule

@NonNull
protected IModule initModule()

getContainingModule

public IModule getContainingModule()

Specified by:

getContainingModule in interface IModelElement

newInstance

@NonNull
public <CLASS> CLASS newInstance()
                          throws BindingException

Gets a new instance of the bound class.

Specified by:

newInstance in interface IClassBinding

Type Parameters:

CLASS - the type of the bound class

Returns:

a Java object for the class

Throws:

BindingException - if the instance cannot be created due to a binding error

callBeforeDeserialize

public void callBeforeDeserialize(Object targetObject,
                                  Object parentObject)
                           throws BindingException

Calls the method named "beforeDeserialize" on each class in the object's hierarchy if the method exists on the class.

These methods can be used to set the initial state of the target bound object before data is read and applied during deserialization.

Specified by:

callBeforeDeserialize in interface IClassBinding

Parameters:

targetObject - the data object target to call the method(s) on

parentObject - the object target's parent object, which is used as the method argument

Throws:

BindingException - if an error occurs while calling the method

callAfterDeserialize

public void callAfterDeserialize(Object targetObject,
                                 Object parentObject)
                          throws BindingException

Calls the method named "afterDeserialize" on each class in the object's hierarchy if the method exists.

These methods can be used to modify the state of the target bound object after data is read and applied during deserialization.

Specified by:

callAfterDeserialize in interface IClassBinding

Parameters:

targetObject - the data object target to call the method(s) on

parentObject - the object target's parent object, which is used as the method argument

Throws:

BindingException - if an error occurs while calling the method

copyBoundObject

public Object copyBoundObject(Object item,
                              Object parentInstance)
                       throws BindingException

Description copied from interface: IClassBinding

Create a deep copy of the provided bound object.

Specified by:

copyBoundObject in interface IClassBinding

Parameters:

item - the bound object to copy

parentInstance - the new object's parent instance or null

Returns:

the copy

Throws:

BindingException - if an error occurred copying content between java instances