package gov.nist.secauto.oscal.lib.model;
   
   import gov.nist.secauto.metaschema.binding.model.annotations.AssemblyConstraints;
   import gov.nist.secauto.metaschema.binding.model.annotations.BoundAssembly;
   import gov.nist.secauto.metaschema.binding.model.annotations.BoundField;
   import gov.nist.secauto.metaschema.binding.model.annotations.BoundFieldValue;
   import gov.nist.secauto.metaschema.binding.model.annotations.GroupAs;
   import gov.nist.secauto.metaschema.binding.model.annotations.IsUnique;
   import gov.nist.secauto.metaschema.binding.model.annotations.KeyField;
  import gov.nist.secauto.metaschema.binding.model.annotations.MetaschemaAssembly;
  import gov.nist.secauto.metaschema.model.common.JsonGroupAsBehavior;
  import gov.nist.secauto.metaschema.model.common.constraint.IConstraint;
  import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline;
  import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultilineAdapter;
  import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
  import java.lang.Override;
  import java.lang.String;
  import java.util.LinkedList;
  import java.util.List;
  import org.apache.commons.lang3.builder.MultilineRecursiveToStringStyle;
  import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
  
  /**
   * A description of the logical flow of information within the system and across its boundaries, optionally supplemented by diagrams that illustrate these flows.
   */
  @MetaschemaAssembly(
      formalName = "Data Flow",
      description = "A description of the logical flow of information within the system and across its boundaries, optionally supplemented by diagrams that illustrate these flows.",
      name = "data-flow",
      metaschema = OscalSspMetaschema.class
  )
  @AssemblyConstraints(
      isUnique = @IsUnique(id = "unique-ssp-data-flow-diagram", level = IConstraint.Level.ERROR, target = "diagram", keyFields = @KeyField(target = "@uuid"), remarks = "A given `uuid` must be assigned only once to a diagram.")
  )
  public class DataFlow {
    /**
     * "A summary of the system's data flow."
     */
    @BoundField(
        formalName = "Data Flow Description",
        description = "A summary of the system's data flow.",
        useName = "description",
        minOccurs = 1
    )
    @BoundFieldValue(
        typeAdapter = MarkupMultilineAdapter.class
    )
    private MarkupMultiline _description;
  
    @BoundAssembly(
        formalName = "Property",
        description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
        useName = "prop",
        maxOccurs = -1
    )
    @GroupAs(
        name = "props",
        inJson = JsonGroupAsBehavior.LIST
    )
    private List<Property> _props;
  
    @BoundAssembly(
        formalName = "Link",
        description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
        useName = "link",
        maxOccurs = -1
    )
    @GroupAs(
        name = "links",
        inJson = JsonGroupAsBehavior.LIST
    )
    private List<Link> _links;
  
    @BoundAssembly(
        formalName = "Diagram",
        description = "A graphic that provides a visual representation the system, or some aspect of it.",
        useName = "diagram",
        maxOccurs = -1
    )
    @GroupAs(
        name = "diagrams",
        inJson = JsonGroupAsBehavior.LIST
    )
    private List<Diagram> _diagrams;
  
    @BoundField(
        formalName = "Remarks",
        description = "Additional commentary about the containing object.",
        useName = "remarks"
    )
    @BoundFieldValue(
        typeAdapter = MarkupMultilineAdapter.class
    )
    private MarkupMultiline _remarks;
  
    public DataFlow() {
    }
  
    public MarkupMultiline getDescription() {
     return _description;
   }
 
   public void setDescription(MarkupMultiline value) {
     _description = value;
   }
 
   public List<Property> getProps() {
     return _props;
   }
 
   public void setProps(List<Property> value) {
     _props = value;
   }
 
   /**
    * Add a new {@link Property} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addProp(Property item) {
     Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_props == null) {
       _props = new LinkedList<>();
     }
     return _props.add(value);
   }
 
   /**
    * Remove the first matching {@link Property} 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 removeProp(Property item) {
     Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _props == null ? false : _props.remove(value);
   }
 
   public List<Link> getLinks() {
     return _links;
   }
 
   public void setLinks(List<Link> value) {
     _links = value;
   }
 
   /**
    * Add a new {@link Link} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addLink(Link item) {
     Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_links == null) {
       _links = new LinkedList<>();
     }
     return _links.add(value);
   }
 
   /**
    * Remove the first matching {@link Link} 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 removeLink(Link item) {
     Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _links == null ? false : _links.remove(value);
   }
 
   public List<Diagram> getDiagrams() {
     return _diagrams;
   }
 
   public void setDiagrams(List<Diagram> value) {
     _diagrams = value;
   }
 
   /**
    * Add a new {@link Diagram} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addDiagram(Diagram item) {
     Diagram value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_diagrams == null) {
       _diagrams = new LinkedList<>();
     }
     return _diagrams.add(value);
   }
 
   /**
    * Remove the first matching {@link Diagram} 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 removeDiagram(Diagram item) {
     Diagram value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _diagrams == null ? false : _diagrams.remove(value);
   }
 
   public MarkupMultiline getRemarks() {
     return _remarks;
   }
 
   public void setRemarks(MarkupMultiline value) {
     _remarks = value;
   }
 
   @Override
   public String toString() {
     return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
   }
 }