Module gov.nist.secauto.metaschema.databind

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

Class METASCHEMA.DefineField

java.lang.Object

gov.nist.secauto.metaschema.databind.model.binding.metaschema.METASCHEMA.DefineField

All Implemented Interfaces:

IBoundObject

Enclosing class:

METASCHEMA

@MetaschemaAssembly(formalName="Global Field Definition",
                    name="define-field",
                    moduleClass=MetaschemaModelModule.class)
public static class METASCHEMA.DefineField
extends Object
implements IBoundObject

Constructor Summary

Constructors

Constructor	Description
DefineField()
DefineField(IMetaschemaData data)

Method Summary

Modifier and Type	Method	Description
boolean	addExample(Example item)	Add a new Example item to the underlying collection.
boolean	addProp(Property item)	Add a new Property item to the underlying collection.
String	getAsType()
FieldConstraints	getConstraint()
String	getDefault()
String	getDeprecated()
MarkupLine	getDescription()
List<Example>	getExamples()
List<Object>	getFlags()
String	getFormalName()
BigInteger	getIndex()
JsonKey	getJsonKey()
String	getJsonValueKey()
JsonValueKeyFlag	getJsonValueKeyFlag()
IMetaschemaData	getMetaschemaData()
String	getName()
List<Property>	getProps()
Remarks	getRemarks()
String	getScope()
UseName	getUseName()
boolean	removeExample(Example item)	Remove the first matching Example item from the underlying collection.
boolean	removeProp(Property item)	Remove the first matching Property item from the underlying collection.
void	setAsType(String value)
void	setConstraint(FieldConstraints value)
void	setDefault(String value)
void	setDeprecated(String value)
void	setDescription(MarkupLine value)
void	setExamples(List<Example> value)
void	setFlags(List<Object> value)
void	setFormalName(String value)
void	setIndex(BigInteger value)
void	setJsonKey(JsonKey value)
void	setJsonValueKey(String value)
void	setJsonValueKeyFlag(JsonValueKeyFlag value)
void	setName(String value)
void	setProps(List<Property> value)
void	setRemarks(Remarks value)
void	setScope(String value)
void	setUseName(UseName value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefineField

public DefineField()

DefineField

public DefineField(IMetaschemaData data)

Method Details

getMetaschemaData

public IMetaschemaData getMetaschemaData()

Specified by:

getMetaschemaData in interface IBoundObject

getName

public String getName()

setName

public void setName(String value)

getIndex

public BigInteger getIndex()

setIndex

public void setIndex(BigInteger value)

getScope

public String getScope()

setScope

public void setScope(String value)

getDeprecated

public String getDeprecated()

setDeprecated

public void setDeprecated(String value)

getAsType

public String getAsType()

setAsType

public void setAsType(String value)

getDefault

public String getDefault()

setDefault

public void setDefault(String value)

getFormalName

public String getFormalName()

setFormalName

public void setFormalName(String value)

getDescription

public MarkupLine getDescription()

setDescription

public void setDescription(MarkupLine value)

getProps

public List<Property> getProps()

setProps

public void setProps(List<Property> value)

addProp

public boolean addProp(Property item)

Add a new Property item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeProp

public boolean removeProp(Property item)

Remove the first matching Property item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getUseName

public UseName getUseName()

setUseName

public void setUseName(UseName value)

getJsonKey

public JsonKey getJsonKey()

setJsonKey

public void setJsonKey(JsonKey value)

getJsonValueKey

public String getJsonValueKey()

setJsonValueKey

public void setJsonValueKey(String value)

getJsonValueKeyFlag

public JsonValueKeyFlag getJsonValueKeyFlag()

setJsonValueKeyFlag

public void setJsonValueKeyFlag(JsonValueKeyFlag value)

getFlags

public List<Object> getFlags()

setFlags

public void setFlags(List<Object> value)

getConstraint

public FieldConstraints getConstraint()

setConstraint

public void setConstraint(FieldConstraints value)

getRemarks

public Remarks getRemarks()

setRemarks

public void setRemarks(Remarks value)

getExamples

public List<Example> getExamples()

setExamples

public void setExamples(List<Example> value)

addExample

public boolean addExample(Example item)

Add a new Example item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeExample

public boolean removeExample(Example item)

Remove the first matching Example 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