/*
    * 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.oscal.lib.model.metadata;
  
  import gov.nist.secauto.metaschema.model.common.util.CollectionUtil;
  import gov.nist.secauto.oscal.lib.model.Property;
  
  import java.net.URI;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Objects;
  import java.util.Optional;
  import java.util.UUID;
  import java.util.stream.Collectors;
  import java.util.stream.Stream;
  
  import javax.xml.namespace.QName;
  
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  public abstract class AbstractProperty implements IProperty {
  
    @NonNull
    public static QName qname(URI namespace, @NonNull String name) {
      return new QName(normalizeNamespace(namespace).toString(), name);
    }
  
    @NonNull
    public static QName qname(@NonNull String name) {
      return new QName(OSCAL_NAMESPACE.toString(), name);
    }
  
    @NonNull
    public static URI normalizeNamespace(URI namespace) {
      URI propertyNamespace = namespace;
      if (propertyNamespace == null) {
        propertyNamespace = OSCAL_NAMESPACE;
      }
      return propertyNamespace;
    }
  
    @SuppressWarnings("null")
    @NonNull
    public static Optional<Property> find(List<Property> props, @NonNull QName qname) {
      return CollectionUtil.listOrEmpty(props).stream().filter(prop -> qname.equals(prop.getQName())).findFirst();
    }
  
    protected AbstractProperty() {
      // only concrete classes should construct
    }
  
    public static List<Property> merge(@NonNull List<Property> original, @NonNull List<Property> additional) {
      return Stream.concat(original.stream(), additional.stream())
          .collect(Collectors.toCollection(LinkedList::new));
    }
  
    @Override
    public boolean isNamespaceEqual(@NonNull URI namespace) {
      return normalizeNamespace(getNs()).equals(namespace);
    }
  
    @NonNull
    public QName getQName() {
      return new QName(normalizeNamespace(getNs()).toString(), getName());
    }
  
    @NonNull
    public static Builder builder(@NonNull String name) {
      return new Builder(name);
    }
  
    public static class Builder {
      @NonNull
      private final String name;
  
     private UUID uuid;
     private URI namespace;
     private String value;
     private String clazz;
 
     public Builder(@NonNull String name) {
       this.name = Objects.requireNonNull(name, "name");
     }
 
     @NonNull
     public Builder uuid(@NonNull UUID uuid) {
       this.uuid = Objects.requireNonNull(uuid);
       return this;
     }
 
     @NonNull
     public Builder namespace(@NonNull URI namespace) {
       if (IProperty.OSCAL_NAMESPACE.equals(namespace)) {
         this.namespace = null;
       } else {
         this.namespace = Objects.requireNonNull(namespace);
       }
       return this;
     }
 
     @NonNull
     public Builder value(@NonNull String value) {
       this.value = Objects.requireNonNull(value);
       return this;
     }
 
     @NonNull
     public Builder clazz(@NonNull String clazz) {
       this.clazz = Objects.requireNonNull(clazz);
       return this;
     }
 
     @NonNull
     public Property build() {
       Property retval = new Property();
       retval.setName(name);
       retval.setValue(Objects.requireNonNull(value, "value"));
       if (uuid != null) {
         retval.setUuid(uuid);
       }
       if (namespace != null) {
         retval.setNs(namespace);
       }
       if (clazz != null) {
         retval.setClazz(clazz);
       }
 
       return retval;
     }
   }
 }