/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.juneau.bean.openapi3;

import static org.apache.juneau.commons.utils.Shorts.*;
import static org.apache.juneau.commons.utils.StringUtils.*;
import static org.apache.juneau.marshall.internal.ConverterUtils.*;

import java.net.*;
import java.util.*;

import org.apache.juneau.commons.collections.*;
import org.apache.juneau.marshall.*;

/**
 * License information for the exposed API.
 *
 * <p>
 * The License Object provides license information for the exposed API. This information helps clients understand
 * the terms under which the API can be used, including any restrictions or requirements.
 *
 * <h5 class='section'>OpenAPI Specification:</h5>
 * <p>
 * The License Object is composed of the following fields:
 * <ul class='spaced-list'>
 *    <li><c>name</c> (string, REQUIRED) - The license name used for the API
 *    <li><c>url</c> (string) - A URL to the license used for the API
 * </ul>
 *
 * <h5 class='section'>Example:</h5>
 * <p class='bcode'>
 *    <jc>// Construct using SwaggerBuilder.</jc>
 *    License <jv>x</jv> = <jsm>license</jsm>(<js>"Apache 2.0"</js>, <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>);
 *
 *    <jc>// Serialize using JsonSerializer.</jc>
 *    String <jv>json</jv> = Json.<jsm>from</jsm>(<jv>x</jv>);
 *
 *    <jc>// Or just use toString() which does the same as above.</jc>
 *    String <jv>json</jv> = <jv>x</jv>.toString();
 * </p>
 * <p class='bcode'>
 *    <jc>// Output</jc>
 *    {
 *       <js>"name"</js>: <js>"Apache 2.0"</js>,
 *       <js>"url"</js>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>
 *    }
 * </p>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://spec.openapis.org/oas/v3.0.0#license-object">OpenAPI Specification &gt; License Object</a>
 *    <li class='link'><a class="doclink" href="https://swagger.io/docs/specification/api-general-info/">OpenAPI API General Info</a>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanOpenApi3">juneau-bean-openapi-v3</a>
 * </ul>
 */
@SuppressWarnings({
   "java:S1192" // Duplicated literals (argument/property names) read more clearly inline than as constants
})
public class License extends OpenApiElement {

   private String name;
   private URI url;

   /**
    * Default constructor.
    */
   public License() {}

   /**
    * Copy constructor.
    *
    * @param copyFrom The object to copy.
    */
   public License(License copyFrom) {
      super(copyFrom);

      this.name = copyFrom.name;
      this.url = copyFrom.url;
   }

   /**
    * Make a deep copy of this object.
    *
    * @return A deep copy of this object.
    */
   public License copy() {
      return new License(this);
   }

   @Override /* Overridden from OpenApiElement */
   public <T> T get(String property, Class<T> type) {
      reqnn("property", property);
      return switch (property) {
         case "name" -> toType(getName(), type);
         case "url" -> toType(getUrl(), type);
         default -> super.get(property, type);
      };
   }

   /**
    * Bean property getter:  <property>name</property>.
    *
    * <p>
    * The license name used for the API.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public String getName() { return name; }

   /**
    * Bean property getter:  <property>url</property>.
    *
    * <p>
    * A URL to the license used for the API.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public URI getUrl() { return url; }

   @Override /* Overridden from OpenApiElement */
   public Set<String> keySet() {
      // @formatter:off
      var s = stb(String.class)
         .addIf(nn(name), "name")
         .addIf(nn(url), "url")
         .build();
      // @formatter:on
      return new MultiSet<>(s, super.keySet());
   }

   @Override /* Overridden from OpenApiElement */
   public License set(String property, Object value) {
      reqnn("property", property);
      return switch (property) {
         case "name" -> setName(s(value));
         case "url" -> setUrl(toUri(value));
         default -> {
            super.set(property, value);
            yield this;
         }
      };
   }

   /**
    * Bean property setter:  <property>name</property>.
    *
    * <p>
    * The license name used for the API.
    *
    * @param value
    *    The new value for this property.
    *    <br>Property value is required.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public License setName(String value) {
      name = value;
      return this;
   }

   /**
    * Bean property setter:  <property>url</property>.
    *
    * <p>
    * A URL to the license used for the API.
    *
    * @param value
    *    The new value for this property.
    *    <br>URIs defined by {@link UriResolver} can be used for values.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public License setUrl(URI value) {
      url = value;
      return this;
   }

   @Override /* Overridden from OpenApiElement */
   public License strict() {
      super.strict();
      return this;
   }

   @Override /* Overridden from OpenApiElement */
   public License strict(Object value) {
      super.strict(value);
      return this;
   }
}