Module dev.metaschema.databind

Package dev.metaschema.databind.config.binding

Class MetaschemaBindings.MetaschemaBinding.DefineFieldBinding

java.lang.Object

dev.metaschema.databind.config.binding.MetaschemaBindings.MetaschemaBinding.DefineFieldBinding

All Implemented Interfaces:

IBoundObject

Enclosing class:

MetaschemaBindings.MetaschemaBinding

@MetaschemaAssembly(formalName="Define Field Binding",
                    description="Provides binding configurations for a given defined field within the parent metaschema.",
                    name="define-field-binding",
                    moduleClass=MetaschemaBindingsModule.class)
public static class MetaschemaBindings.MetaschemaBinding.DefineFieldBinding
extends Object
implements IBoundObject

Provides binding configurations for a given defined field within the parent metaschema.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.Java	Field and assembly binding configurations for Java bound classes.
static class	MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding	Provides binding configurations for a property within the parent definition.

Constructor Summary

Constructors

Constructor	Description
DefineFieldBinding()	Constructs a new dev.metaschema.databind.config.binding.MetaschemaBindings.MetaschemaBinding.DefineFieldBinding instance with no metadata.
DefineFieldBinding(IMetaschemaData data)	Constructs a new dev.metaschema.databind.config.binding.MetaschemaBindings.MetaschemaBinding.DefineFieldBinding instance with the specified metadata.

Method Summary

Modifier and Type	Method	Description
boolean	addPropertyBinding(MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item)	Add a new MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item to the underlying collection.
MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.Java	getJava()	Get the java Object Definition Binding.
IMetaschemaData	getMetaschemaData()	Get additional Metaschema-related information for the object (i.e., resource location).
String	getName()	Get the name.
List<MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding>	getPropertyBindings()	Get the property Binding.
String	getTarget()	Get the target.
boolean	removePropertyBinding(MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item)	Remove the first matching MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item from the underlying collection.
void	setJava(MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.Java value)	Set the java Object Definition Binding.
void	setName(String value)	Set the name.
void	setPropertyBindings(List<MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding> value)	Set the property Binding.
void	setTarget(String value)	Set the target.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefineFieldBinding

public DefineFieldBinding()

Constructs a new dev.metaschema.databind.config.binding.MetaschemaBindings.MetaschemaBinding.DefineFieldBinding instance with no metadata.

DefineFieldBinding

public DefineFieldBinding(IMetaschemaData data)

Constructs a new dev.metaschema.databind.config.binding.MetaschemaBindings.MetaschemaBinding.DefineFieldBinding instance with the specified metadata.

Parameters:

data - the metaschema data, or null if none

Method Details

getMetaschemaData

public IMetaschemaData getMetaschemaData()

Description copied from interface: IBoundObject

Get additional Metaschema-related information for the object (i.e., resource location).

Specified by:

getMetaschemaData in interface IBoundObject

Returns:

the Metaschema-related information

getName

@Nullable
public String getName()

Get the name.

The name of the metaschema field. Used for top-level definitions.

Returns:

the name value, or null if not set

setName

public void setName(@Nullable
 String value)

Set the name.

The name of the metaschema field. Used for top-level definitions.

Parameters:

value - the name value to set, or null to clear

getTarget

@Nullable
public String getTarget()

Get the target.

A Metapath expression targeting the field definition(s) within the metaschema. Used for inline definitions.

Returns:

the target value, or null if not set

setTarget

public void setTarget(@Nullable
 String value)

Set the target.

A Metapath expression targeting the field definition(s) within the metaschema. Used for inline definitions.

Parameters:

value - the target value to set, or null to clear

getJava

@Nullable
public MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.Java getJava()

Get the java Object Definition Binding.

Field and assembly binding configurations for Java bound classes.

Returns:

the java value, or null if not set

setJava

public void setJava(@Nullable
 MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.Java value)

Set the java Object Definition Binding.

Field and assembly binding configurations for Java bound classes.

Parameters:

value - the java value to set, or null to clear

getPropertyBindings

@NonNull
public List<MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding> getPropertyBindings()

Get the property Binding.

Provides binding configurations for a property within the parent definition.

Returns:

the property-binding value

setPropertyBindings

public void setPropertyBindings(@NonNull
 List<MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding> value)

Set the property Binding.

Provides binding configurations for a property within the parent definition.

Parameters:

value - the property-binding value to set

addPropertyBinding

public boolean addPropertyBinding(MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item)

Add a new MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removePropertyBinding

public boolean removePropertyBinding(MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item)

Remove the first matching MetaschemaBindings.MetaschemaBinding.DefineFieldBinding.PropertyBinding item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

toString

public String toString()

Overrides:

toString in class Object