Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundDefinitionModelField<ITEM>

Type Parameters:

ITEM - the Java type for associated bound objects

All Superinterfaces:

IAttributable, IBoundDefinition, IBoundDefinitionModel<ITEM>, IBoundModelElement, IBoundModelObject<ITEM>, IContainer, IDefaultable, IDefinition, IDescribable, IFeatureContainerFlag<IBoundInstanceFlag>, IFeatureValueConstrained, IField, IFieldDefinition, IItemValueHandler<ITEM>, IJsonNamed, IModelDefinition, IModelElement, IModelElementVisitable, INamed, INamedModelElement, IValueConstrained, IValuedDefinition

All Known Subinterfaces:

IBoundDefinitionModelFieldComplex, IBoundInstanceModelFieldScalar

public interface IBoundDefinitionModelField<ITEM>
extends IFieldDefinition, IBoundDefinitionModel<ITEM>

Represents a field definition bound to Java data.

Classes and interfaces implementing this interface can be:

• "scalar", meaning they have only a scalar field value, or
• "complex", meaning they allow flags and are bound to a Java class.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.core.model.IAttributable

IAttributable.Key

Nested classes/interfaces inherited from interface dev.metaschema.core.model.IDefinition

IDefinition.ModuleScope

Field Summary

Fields inherited from interface dev.metaschema.core.model.IAttributable

DEFAULT_PROPERY_NAMESPACE

Fields inherited from interface dev.metaschema.core.model.IDefinition

DEFAULT_MODULE_SCOPE

Method Summary

Modifier and Type	Method	Description
default IBoundInstanceModelField<ITEM>	getInlineInstance()	If IDefinition.isInline() is true, return the instance the definition is inlined for.
IBoundInstanceFlag	getJsonValueKeyFlagInstance()	Retrieves the flag instance whose value will be used as the "value key".

Methods inherited from interface dev.metaschema.core.model.IAttributable

getProperties, getPropertyValues, hasProperty, hasPropertyValue

Methods inherited from interface dev.metaschema.databind.model.IBoundDefinitionModel

getBindingContext

Methods inherited from interface dev.metaschema.databind.model.IBoundModelElement

getContainingModule

Methods inherited from interface dev.metaschema.databind.model.IBoundModelObject

canHandleXmlQName

Methods inherited from interface dev.metaschema.core.model.IDefaultable

getDefaultValue, getEffectiveDefaultValue, getResolvedDefaultValue

Methods inherited from interface dev.metaschema.core.model.IDefinition

getDefinitionQName, getLocation, getModuleScope, toCoordinates

Methods inherited from interface dev.metaschema.core.model.IDescribable

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

Methods inherited from interface dev.metaschema.core.model.IFeatureContainerFlag

getFlagContainer, getFlagInstanceByName, getFlagInstances, getJsonKey

Methods inherited from interface dev.metaschema.core.model.constraint.IFeatureValueConstrained

addConstraint, addConstraint, addConstraint, addConstraint, addConstraint, addLetExpression, getAllowedValuesConstraints, getConstraints, getConstraintSupport, getExpectConstraints, getIndexHasKeyConstraints, getLetExpressions, getMatchesConstraints, getReportConstraints

Methods inherited from interface dev.metaschema.core.model.IField

getModelType

Methods inherited from interface dev.metaschema.core.model.IFieldDefinition

accept, getEffectiveJsonValueKeyName, getFieldValue, getJsonValueKey, getJsonValueKeyName, hasJsonValueKeyFlagInstance, isInline

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

deepCopyItem, readItem, writeItem

Methods inherited from interface dev.metaschema.core.model.IModelDefinition

hasChildren

Methods inherited from interface dev.metaschema.core.model.IModelElement

getRemarks

Methods inherited from interface dev.metaschema.core.model.INamed

getEffectiveIndex, getEffectiveName, getIndex, getName, getQName, getUseIndex, getUseName

Methods inherited from interface dev.metaschema.core.model.INamedModelElement

getJsonName

Methods inherited from interface dev.metaschema.core.model.constraint.IValueConstrained

getSource

Methods inherited from interface dev.metaschema.core.model.IValuedDefinition

getJavaTypeAdapter

Method Details

getInlineInstance

default IBoundInstanceModelField<ITEM> getInlineInstance()

Description copied from interface: IDefinition

If IDefinition.isInline() is true, return the instance the definition is inlined for.

If this method returns null, then IDefinition.getInlineInstance() must return false.

Specified by:

getInlineInstance in interface IBoundDefinitionModel<ITEM>

Specified by:

getInlineInstance in interface IDefinition

Specified by:

getInlineInstance in interface IFieldDefinition

Returns:

the instance or null otherwise

See Also:

• IDefinition.isInline()

getJsonValueKeyFlagInstance

@Nullable
IBoundInstanceFlag getJsonValueKeyFlagInstance()

Description copied from interface: IFieldDefinition

Retrieves the flag instance whose value will be used as the "value key".

Specified by:

getJsonValueKeyFlagInstance in interface IFieldDefinition

Returns:

the configured flag instance, or null if a flag is not configured as the "value key"