gov.nist.secauto.metaschema.model.common.metapath.item.IFlagNodeItem 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.metapath.item;

import gov.nist.secauto.metaschema.model.common.IFlagDefinition;
import gov.nist.secauto.metaschema.model.common.IFlagInstance;
import gov.nist.secauto.metaschema.model.common.metapath.format.IPathFormatter;

import org.jetbrains.annotations.NotNull;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.stream.Stream;

public interface IFlagNodeItem extends IAtomicValuedNodeItem {
  @Override
  default NodeItemType getNodeItemType() {
    return NodeItemType.FLAG;
  }

  @Override
  default IFlagNodeItem getContextNodeItem() {
    return this;
  }

  @Override
  default IFlagNodeItem getNodeItem() {
    return this;
  }

  @Override
  @NotNull
  IModelNodeItem getParentContentNodeItem();

  @Override
  IModelNodeItem getParentNodeItem();

  @Override
  IFlagDefinition getDefinition();

  @Override
  IFlagInstance getInstance();

  /**
   * Flags do not have flag items. This call should return an empty collection.
   */
  @SuppressWarnings("null")
  @Override
  default Collection<@NotNull ? extends IFlagNodeItem> getFlags() {
    // a flag does not have flags
    return Collections.emptyList();
  }

  /**
   * Flags do not have flag items. This call should return {@code null}.
   */
  @Override
  default IFlagNodeItem getFlagByName(@NotNull String name) {
    // a flag does not have flags
    return null;
  }

  /**
   * Flags do not have flag items. This call should return an empty stream.
   */
  @SuppressWarnings("null")
  @Override
  default @NotNull Stream flags() {
    // a flag does not have flags
    return Stream.empty();
  }

  /**
   * Flags do not have model items. This call should return an empty collection.
   */
  @SuppressWarnings("null")
  @Override
  default @NotNull Collection<@NotNull ? extends List<@NotNull ? extends IModelNodeItem>> getModelItems() {
    // a flag does not have model items
    return Collections.emptyList();
  }

  /**
   * Flags do not have model items. This call should return an empty list.
   */
  @SuppressWarnings("null")
  @Override
  default @NotNull List<@NotNull ? extends IModelNodeItem> getModelItemsByName(String name) {
    // a flag does not have model items
    return Collections.emptyList();
  }

  /**
   * Flags do not have model items. This call should return an empty stream.
   */
  @SuppressWarnings("null")
  @NotNull
  @Override
  default Stream modelItems() {
    // a flag does not have model items
    return Stream.empty();
  }

  @Override
  default @NotNull String format(@NotNull IPathFormatter formatter) {
    return formatter.formatFlag(this);
  }

  @Override
  default  RESULT accept(@NotNull INodeItemVisitor visitor, CONTEXT context) {
    return visitor.visitFlag(this, context);
  }
}