Module dev.metaschema.databind

Package dev.metaschema.databind.model.metaschema.binding

Class UseName

java.lang.Object

dev.metaschema.databind.model.metaschema.binding.UseName

All Implemented Interfaces:

dev.metaschema.core.model.IBoundObject

@MetaschemaField(formalName="Use Name",
                 description="Allows the name of the definition to be overridden.",
                 name="use-name",
                 moduleClass=MetaschemaModelModule.class)
public class UseName
extends Object
implements dev.metaschema.core.model.IBoundObject

Allows the name of the definition to be overridden.

Constructor Summary

Constructors

Constructor	Description
UseName()	Constructs a new dev.metaschema.databind.model.metaschema.binding.UseName instance with no metadata.
UseName(dev.metaschema.core.model.IMetaschemaData data)	Constructs a new dev.metaschema.databind.model.metaschema.binding.UseName instance with the specified metadata.

Method Summary

Modifier and Type	Method	Description
BigInteger	getIndex()	Get the numeric Index.
dev.metaschema.core.model.IMetaschemaData	getMetaschemaData()
String	getName()	Get the field value.
void	setIndex(BigInteger value)	Set the numeric Index.
void	setName(String value)	Set the field value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

UseName

public UseName()

Constructs a new dev.metaschema.databind.model.metaschema.binding.UseName instance with no metadata.

UseName

public UseName(dev.metaschema.core.model.IMetaschemaData data)

Constructs a new dev.metaschema.databind.model.metaschema.binding.UseName instance with the specified metadata.

Parameters:

data - the metaschema data, or null if none

Method Details

getMetaschemaData

public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()

Specified by:

getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

getIndex

@Nullable
public BigInteger getIndex()

Get the numeric Index.

Used for binary formats instead of the textual name.

Returns:

the index value, or null if not set

setIndex

public void setIndex(@Nullable
 BigInteger value)

Set the numeric Index.

Used for binary formats instead of the textual name.

Parameters:

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

getName

@Nullable
public String getName()

Get the field value.

Returns:

the value

setName

public void setName(@Nullable
 String value)

Set the field value.

Parameters:

value - the value to set

toString

public String toString()

Overrides:

toString in class Object