gov.nist.secauto.metaschema.model.common.RootAssemblyDefinitionInstance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metaschema-model-common Show documentation
The core API for working with Metaschema-based models.
There is a newer version: 0.12.2
Show newest version
/*
 * Portions of this software was developed by employees of the National Institute
 * of Standards and Technology (NIST), an agency of the Federal Government and is
 * being made available as a public service. Pursuant to title 17 United States
 * Code Section 105, works of NIST employees are not subject to copyright
 * protection in the United States. This software may be subject to foreign
 * copyright. Permission in the United States and in foreign countries, to the
 * extent that NIST may hold copyright, to use, copy, modify, create derivative
 * works, and distribute this software and its documentation without fee is hereby
 * granted on a non-exclusive basis, provided that this notice and disclaimer
 * of warranty appears in all copies.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
 */

package gov.nist.secauto.metaschema.model.common;

import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline;
import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;

import org.jetbrains.annotations.NotNull;

import javax.xml.namespace.QName;

public class RootAssemblyDefinitionInstance implements IAssemblyInstance {
  @NotNull
  private final IAssemblyDefinition rootAssemblyDefinition;

  /**
   * Construct a new root assembly instanced based on the provided definition. The provided definition
   * must be a root assembly definition.
   * 
   * @param definition
   *          the root assembly definition
   */
  public RootAssemblyDefinitionInstance(@NotNull IAssemblyDefinition definition) {
    if (!definition.isRoot()) {
      throw new IllegalArgumentException();
    }
    this.rootAssemblyDefinition = definition;
  }

  /**
   * Get the underlying definition used for this root-level instance.
   * 
   * @return the proxied definition
   */
  @NotNull
  protected IAssemblyDefinition getProxy() {
    return rootAssemblyDefinition;
  }

  @Override
  public String getName() {
    IAssemblyDefinition rootAssembly = getProxy();
    // guaranteed to be not null, since we know the proxy is a root assembly
    @SuppressWarnings("null")
    @NotNull
    String retval = (@NotNull String) rootAssembly.getRootName();
    return retval;
  }

  @Override
  public String getUseName() {
    return null;
  }

  @SuppressWarnings("null")
  @Override
  public String getXmlNamespace() {
    return getXmlQName().getNamespaceURI();
  }

  @Override
  public QName getXmlQName() {
    return ObjectUtils.requireNonNull(getProxy().getRootXmlQName(), "the XML root QName is expected to be non-null");
  }

  @Override
  public String toCoordinates() {
    return getProxy().toCoordinates();
  }

  @Override
  public MarkupMultiline getRemarks() {
    return getProxy().getRemarks();
  }

  @Override
  public IAssemblyDefinition getContainingDefinition() {
    return null;
  }

  @Override
  public int getMinOccurs() {
    return 1;
  }

  @Override
  public int getMaxOccurs() {
    return 1;
  }

  @Override
  public String getGroupAsName() {
    return null;
  }

  @Override
  public String getGroupAsXmlNamespace() {
    return null;
  }

  @Override
  public JsonGroupAsBehavior getJsonGroupAsBehavior() {
    return JsonGroupAsBehavior.NONE;
  }

  @Override
  public XmlGroupAsBehavior getXmlGroupAsBehavior() {
    return XmlGroupAsBehavior.UNGROUPED;
  }

  @Override
  public IAssemblyDefinition getDefinition() {
    return getProxy();
  }

  @Override
  public IMetaschema getContainingMetaschema() {
    return getProxy().getContainingMetaschema();
  }
}