Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.model

Interface IFlagInstance

All Superinterfaces:

IFlag, IInstance, IModelElement, INamedInstance, INamedModelElement

All Known Implementing Classes:

AbstractFlagInstance

public interface IFlagInstance
extends INamedInstance, IFlag

Method Summary

Modifier and Type	Method	Description
IFlagDefinition	getDefinition()	Retrieve the definition of this instance.
IFlagContainer	getParentContainer()	Get the parent model definition that serves as the container of this instance.
default String	getXmlNamespace()	Retrieve the XML namespace for this instance.
default QName	getXmlQName()	Get the XML qualified name to use in XML.
default boolean	isJsonKey()	Determines if this flag's value is used as the property name for the JSON object that holds the remaining data based on this flag's containing definition.
default boolean	isJsonValueKey()	Determines if this flag is used as a JSON "value key".
boolean	isRequired()	Determines if a flag value is required to be provided.

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

getModelType

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

getContainingDefinition, getContainingModule

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

getRemarks

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

getEffectiveDescription, getEffectiveFormalName, getEffectiveName, getValue, toCoordinates

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

getDescription, getFormalName, getJsonName, getName, getProperties, getPropertyValues, getUseName, hasProperty, hasPropertyValue

Method Detail

getParentContainer

IFlagContainer getParentContainer()

Description copied from interface: IInstance

Get the parent model definition that serves as the container of this instance.

Specified by:

getParentContainer in interface IInstance

Returns:

the container

getXmlNamespace

default String getXmlNamespace()

Description copied from interface: INamedInstance

Retrieve the XML namespace for this instance.

Specified by:

getXmlNamespace in interface INamedInstance

Returns:

the XML namespace or null if no namespace is defined

getXmlQName

@NonNull
default QName getXmlQName()

Description copied from interface: INamedInstance

Get the XML qualified name to use in XML.

Specified by:

getXmlQName in interface INamedInstance

Returns:

the XML qualified name, or null if there isn't one

getDefinition

IFlagDefinition getDefinition()

Description copied from interface: INamedInstance

Retrieve the definition of this instance.

Specified by:

getDefinition in interface INamedInstance

Returns:

the corresponding definition

isRequired

boolean isRequired()

Determines if a flag value is required to be provided.

Returns:

true if a value is required, or false otherwise

isJsonKey

default boolean isJsonKey()

Determines if this flag's value is used as the property name for the JSON object that holds the remaining data based on this flag's containing definition.

Returns:

true if this flag is used as a JSON key, or false otherwise

isJsonValueKey

default boolean isJsonValueKey()

Determines if this flag is used as a JSON "value key". A "value key" is a flag who's value is used as the property name for the containing objects value.

Returns:

true if the flag is used as a JSON "value key", or false otherwise