MetapathContext.java

/*
 * SPDX-FileCopyrightText: none
 * SPDX-License-Identifier: CC0-1.0
 */

package gov.nist.secauto.metaschema.databind.model.metaschema.binding;

import gov.nist.secauto.metaschema.core.model.IBoundObject;
import gov.nist.secauto.metaschema.core.model.IMetaschemaData;
import gov.nist.secauto.metaschema.core.model.JsonGroupAsBehavior;
import gov.nist.secauto.metaschema.core.util.ObjectUtils;
import gov.nist.secauto.metaschema.databind.model.annotations.BoundAssembly;
import gov.nist.secauto.metaschema.databind.model.annotations.BoundField;
import gov.nist.secauto.metaschema.databind.model.annotations.GroupAs;
import gov.nist.secauto.metaschema.databind.model.annotations.MetaschemaAssembly;

import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;

import java.util.LinkedList;
import java.util.List;

@SuppressWarnings({
    "PMD.DataClass",
    "PMD.FieldNamingConventions",
})
@MetaschemaAssembly(
    name = "metapath-context",
    moduleClass = MetaschemaModelModule.class)
public class MetapathContext implements IBoundObject {
  private final IMetaschemaData __metaschemaData;

  @BoundAssembly(
      description = "A Metapath expression identifying the model node that the constraints will be applied to.",
      useName = "metapath",
      minOccurs = 1,
      maxOccurs = -1,
      groupAs = @GroupAs(name = "metapaths", inJson = JsonGroupAsBehavior.LIST))
  private List<MetaschemaMetapath> _metapaths;

  @BoundAssembly(
      useName = "constraints")
  private AssemblyConstraints _constraints;

  @BoundAssembly(
      useName = "context",
      maxOccurs = -1,
      groupAs = @GroupAs(name = "contexts", inJson = JsonGroupAsBehavior.LIST))
  private List<MetapathContext> _contexts;

  @BoundField(
      formalName = "Remarks",
      description = "Any explanatory or helpful information to be provided about the remarks parent.",
      useName = "remarks")
  private Remarks _remarks;

  public MetapathContext() {
    this(null);
  }

  public MetapathContext(IMetaschemaData data) {
    this.__metaschemaData = data;
  }

  @Override
  public IMetaschemaData getMetaschemaData() {
    return __metaschemaData;
  }

  public List<MetaschemaMetapath> getMetapaths() {
    return _metapaths;
  }

  public void setMetapaths(List<MetaschemaMetapath> value) {
    _metapaths = value;
  }

  /**
   * Add a new {@link MetaschemaMetapath} item to the underlying collection.
   *
   * @param item
   *          the item to add
   * @return {@code true}
   */
  public boolean addMetapath(MetaschemaMetapath item) {
    MetaschemaMetapath value = ObjectUtils.requireNonNull(item, "item cannot be null");
    if (_metapaths == null) {
      _metapaths = new LinkedList<>();
    }
    return _metapaths.add(value);
  }

  /**
   * Remove the first matching {@link MetaschemaMetapath} item from the underlying
   * collection.
   *
   * @param item
   *          the item to remove
   * @return {@code true} if the item was removed or {@code false} otherwise
   */
  public boolean removeMetapath(MetaschemaMetapath item) {
    MetaschemaMetapath value = ObjectUtils.requireNonNull(item, "item cannot be null");
    return _metapaths != null && _metapaths.remove(value);
  }

  public AssemblyConstraints getConstraints() {
    return _constraints;
  }

  public void setConstraints(AssemblyConstraints value) {
    _constraints = value;
  }

  public List<MetapathContext> getContexts() {
    return _contexts;
  }

  public void setContexts(List<MetapathContext> value) {
    _contexts = value;
  }

  /**
   * Add a new {@link MetapathContext} item to the underlying collection.
   *
   * @param item
   *          the item to add
   * @return {@code true}
   */
  public boolean addContext(MetapathContext item) {
    MetapathContext value = ObjectUtils.requireNonNull(item, "item cannot be null");
    if (_contexts == null) {
      _contexts = new LinkedList<>();
    }
    return _contexts.add(value);
  }

  /**
   * Remove the first matching {@link MetapathContext} item from the underlying
   * collection.
   *
   * @param item
   *          the item to remove
   * @return {@code true} if the item was removed or {@code false} otherwise
   */
  public boolean removeContext(MetapathContext item) {
    MetapathContext value = ObjectUtils.requireNonNull(item, "item cannot be null");
    return _contexts != null && _contexts.remove(value);
  }

  public Remarks getRemarks() {
    return _remarks;
  }

  public void setRemarks(Remarks value) {
    _remarks = value;
  }

  @Override
  public String toString() {
    return new ReflectionToStringBuilder(this, ToStringStyle.MULTI_LINE_STYLE).toString();
  }
}