Module dev.metaschema.core
Package dev.metaschema.core.model

Interface IFieldInstanceGrouped

All Superinterfaces:
IAttributable, IDefaultable, IDescribable, IField, IFieldInstance, IGroupable, IInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceGrouped, IValuedInstance
All Known Subinterfaces:
IBoundInstanceModelGroupedField
public interface IFieldInstanceGrouped extends INamedModelInstanceGrouped, IFieldInstance
Represents a field instance that appears within a choice or other grouping construct.

Grouped field instances always have XML wrapping enabled and inherit cardinality from their containing group.

  • Method Details

    • isInXmlWrapped

      default boolean isInXmlWrapped()
      Determines if the field is configured to have a wrapper in XML.
      Specified by:
      isInXmlWrapped in interface IFieldInstance
      Returns:
      true if an XML wrapper is required, or false otherwise
      See Also:

    • isEffectiveValueWrappedInXml

      default boolean isEffectiveValueWrappedInXml()
      Description copied from interface: IModelInstance
      Indicate if the instance allows values without an XML element wrapper.
      Specified by:
      isEffectiveValueWrappedInXml in interface IModelInstance
      Returns:
      true if the underlying data type is allowed to be unwrapped, or false otherwise

    • accept

      default <CONTEXT, RESULT> RESULT accept(@NonNull IModelElementVisitor<CONTEXT,RESULT> visitor, CONTEXT context)
      A visitor callback.
      Specified by:
      accept in interface IModelElementVisitable
      Type Parameters:
      CONTEXT - the type of the context parameter
      RESULT - the type of the visitor result
      Parameters:
      visitor - the calling visitor
      context - a parameter used to pass contextual information between visitors
      Returns:
      the visitor result