/*
    * SPDX-FileCopyrightText: none
    * SPDX-License-Identifier: CC0-1.0
    */
   
   package gov.nist.secauto.metaschema.core.model.xml;
   
   import gov.nist.secauto.metaschema.core.MetaschemaConstants;
   import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
  import gov.nist.secauto.metaschema.core.model.IAssemblyInstance;
  import gov.nist.secauto.metaschema.core.model.IChoiceGroupInstance;
  import gov.nist.secauto.metaschema.core.model.IChoiceInstance;
  import gov.nist.secauto.metaschema.core.model.IFieldDefinition;
  import gov.nist.secauto.metaschema.core.model.IFieldInstance;
  import gov.nist.secauto.metaschema.core.model.IFlagDefinition;
  import gov.nist.secauto.metaschema.core.model.IFlagInstance;
  import gov.nist.secauto.metaschema.core.model.constraint.IAllowedValuesConstraint;
  import gov.nist.secauto.metaschema.core.model.constraint.ICardinalityConstraint;
  import gov.nist.secauto.metaschema.core.model.constraint.IExpectConstraint;
  import gov.nist.secauto.metaschema.core.model.constraint.IIndexConstraint;
  import gov.nist.secauto.metaschema.core.model.constraint.IIndexHasKeyConstraint;
  import gov.nist.secauto.metaschema.core.model.constraint.IMatchesConstraint;
  import gov.nist.secauto.metaschema.core.model.constraint.IUniqueConstraint;
  import gov.nist.secauto.metaschema.core.qname.IEnhancedQName;
  
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  /**
   * Provides commonly used XML constants related to an XML-based Metaschema
   * module.
   */
  // FIXME: integrate these into the model interfaces or generalize these outside
  // of XML
  @SuppressWarnings("PMD.DataClass")
  public final class XmlModuleConstants {
    /**
     * The name of an {@link IAssemblyInstance} in XML.
     */
    @NonNull
    public static final IEnhancedQName ASSEMBLY_QNAME
        = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "assembly");
  
    /**
     * The name of an inline {@link IAssemblyDefinition} in XML.
     */
    @NonNull
    public static final IEnhancedQName DEFINE_ASSEMBLY_QNAME
        = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "define-assembly");
    /**
     * The name of an {@link IFieldInstance} in XML.
     */
    @NonNull
    public static final IEnhancedQName FIELD_QNAME = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "field");
  
    /**
     * The name of an inline {@link IFieldDefinition} in XML.
     */
    @NonNull
    public static final IEnhancedQName DEFINE_FIELD_QNAME
        = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "define-field");
  
    /**
     * The name of an {@link IFlagInstance} in XML.
     */
    @NonNull
    public static final IEnhancedQName FLAG_QNAME = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "flag");
  
    /**
     * The name of an inline {@link IFlagDefinition} in XML.
     */
    @NonNull
    public static final IEnhancedQName DEFINE_FLAG_QNAME
        = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "define-flag");
  
    /**
     * The name of an {@link IChoiceInstance} in XML.
     */
    @NonNull
    public static final IEnhancedQName CHOICE_QNAME
        = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "choice");
  
    /**
     * The name of an {@link IChoiceGroupInstance} in XML.
     */
    @NonNull
    public static final IEnhancedQName CHOICE_GROUP_QNAME
        = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "choice-group");
  
    /**
     * The name of the element that identifies the model of an
     * {@link IAssemblyDefinition} in XML.
     */
    @NonNull
    public static final IEnhancedQName MODEL_QNAME = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "model");
  
    /**
     * The name of an {@link IAllowedValuesConstraint} constraint in XML.
     */
    @NonNull
   public static final IEnhancedQName ALLOWED_VALUES_CONSTRAINT_QNAME
       = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "allowed-values");
 
   /**
    * The name of an {@link IIndexHasKeyConstraint} constraint in XML.
    */
   @NonNull
   public static final IEnhancedQName INDEX_HAS_KEY_CONSTRAINT_QNAME
       = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "index-has-key");
 
   /**
    * The name of an {@link IMatchesConstraint} constraint in XML.
    */
   @NonNull
   public static final IEnhancedQName MATCHES_CONSTRAINT_QNAME
       = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "matches");
 
   /**
    * The name of an {@link IExpectConstraint} constraint in XML.
    */
   @NonNull
   public static final IEnhancedQName EXPECT_CONSTRAINT_QNAME
       = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "expect");
 
   /**
    * The name of an {@link IIndexConstraint} constraint in XML.
    */
   @NonNull
   public static final IEnhancedQName INDEX_CONSTRAINT_QNAME
       = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "index");
 
   /**
    * The name of an {@link IUniqueConstraint} constraint in XML.
    */
   @NonNull
   public static final IEnhancedQName IS_UNIQUE_CONSTRAINT_QNAME
       = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "is-unique");
 
   /**
    * The name of an {@link ICardinalityConstraint} constraint in XML.
    */
   @NonNull
   public static final IEnhancedQName HAS_CARDINALITY_CONSTRAINT_QNAME
       = IEnhancedQName.of(MetaschemaConstants.METASCHEMA_NAMESPACE, "has-cardinality");
 
   private XmlModuleConstants() {
     // disable construction
   }
 }