/*
 * 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.marshall.internal.ConverterUtils.*;
import static org.apache.juneau.bean.openapi3.OpenApiCopyUtils.*;

import java.util.*;

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

/**
 * Provides metadata about the API.
 *
 * <p>
 * The Info Object contains required and optional metadata about the API, including the title, version, description,
 * terms of service, contact information, and license. This metadata can be used by client tooling and is typically
 * displayed in API documentation interfaces.
 *
 * <h5 class='section'>OpenAPI Specification:</h5>
 * <p>
 * The Info Object is composed of the following fields:
 * <ul class='spaced-list'>
 *    <li><c>title</c> (string, REQUIRED) - The title of the API
 *    <li><c>version</c> (string, REQUIRED) - The version of the OpenAPI document (not the API itself)
 *    <li><c>description</c> (string) - A short description of the API (CommonMark syntax may be used)
 *    <li><c>termsOfService</c> (string) - A URL to the Terms of Service for the API
 *    <li><c>contact</c> ({@link Contact}) - Contact information for the exposed API
 *    <li><c>license</c> ({@link License}) - License information for the exposed API
 * </ul>
 *
 * <h5 class='section'>Example:</h5>
 * <p class='bjava'>
 *    <jc>// Create an Info object</jc>
 *    Info <jv>info</jv> = <jk>new</jk> Info()
 *       .setTitle(<js>"Pet Store API"</js>)
 *       .setVersion(<js>"1.0.0"</js>)
 *       .setDescription(<js>"This is a sample Pet Store Server based on the OpenAPI 3.0 specification."</js>)
 *       .setTermsOfService(<js>"http://example.com/terms/"</js>)
 *       .setContact(
 *          <jk>new</jk> Contact()
 *             .setName(<js>"API Support"</js>)
 *             .setUrl(URI.<jsm>create</jsm>(<js>"http://www.example.com/support"</js>))
 *             .setEmail(<js>"support@example.com"</js>)
 *       )
 *       .setLicense(
 *          <jk>new</jk> License()
 *             .setName(<js>"Apache 2.0"</js>)
 *             .setUrl(URI.<jsm>create</jsm>(<js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>))
 *       );
 * </p>
 * <p class='bjava'>
 *    <jc>// Serialize to JSON</jc>
 *    String <jv>json</jv> = Json.<jsm>from</jsm>(<jv>info</jv>);
 *
 *    <jc>// Or just use toString() which does the same as above.</jc>
 *    <jv>json</jv> = <jv>info</jv>.toString();
 * </p>
 * <p class='bcode'>
 *    <jc>// Output</jc>
 *    {
 *       <js>"title"</js>: <js>"Pet Store API"</js>,
 *       <js>"version"</js>: <js>"1.0.0"</js>,
 *       <js>"description"</js>: <js>"This is a sample Pet Store Server based on the OpenAPI 3.0 specification."</js>,
 *       <js>"termsOfService"</js>: <js>"http://example.com/terms/"</js>,
 *       <js>"contact"</js>: {
 *          <js>"name"</js>: <js>"API Support"</js>,
 *          <js>"url"</js>: <js>"http://www.example.com/support"</js>,
 *          <js>"email"</js>: <js>"support@example.com"</js>
 *       },
 *       <js>"license"</js>: {
 *          <js>"name"</js>: <js>"Apache 2.0"</js>,
 *          <js>"url"</js>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>
 *       },
 *       <js>"version"</js>: <js>"1.0.1"</js>
 *    }
 * </p>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://spec.openapis.org/oas/v3.0.0#info-object">OpenAPI Specification &gt; Info 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 (property names) read more clearly inline than as constants
})
public class Info extends OpenApiElement {

   private String siteName;
   private String title;
   private String description;
   private String termsOfService;
   private String version;
   private Contact contact;
   private License license;

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

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

      this.title = copyFrom.title;
      this.description = copyFrom.description;
      this.siteName = copyFrom.siteName;
      this.termsOfService = copyFrom.termsOfService;
      this.version = copyFrom.version;
      this.contact = copyOf(copyFrom.contact);
      this.license = copyOf(copyFrom.license);
   }

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

   @Override /* Overridden from OpenApiElement */
   public <T> T get(String property, Class<T> type) {
      reqnn("property", property);
      return switch (property) {
         case "title" -> toType(getTitle(), type);
         case "description" -> toType(getDescription(), type);
         case "termsOfService" -> toType(getTermsOfService(), type);
         case "contact" -> toType(getContact(), type);
         case "license" -> toType(getLicense(), type);
         case "siteName" -> toType(getSiteName(), type);
         case "version" -> toType(getVersion(), type);
         default -> super.get(property, type);
      };
   }

   /**
    * Bean property getter:  <property>contact</property>.
    *
    * <p>
    * The contact information for the exposed API.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public Contact getContact() { return contact; }

   /**
    * Bean property getter:  <property>description</property>.
    *
    * <p>
    * A short description of the application.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public String getDescription() { return description; }

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

   /**
    * Bean property getter:  <property>siteName</property>.
    *
    * <p>
    * The site name of the application.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public String getSiteName() { return siteName; }

   /**
    * Bean property getter:  <property>termsOfService</property>.
    *
    * <p>
    * The Terms of Service for the API.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public String getTermsOfService() { return termsOfService; }

   /**
    * Bean property getter:  <property>title</property>.
    *
    * <p>
    * The title of the application.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public String getTitle() { return title; }

   /**
    * Bean property getter:  <property>version</property>.
    *
    * <p>
    * Provides the version of the application API (not to be confused with the specification version).
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public String getVersion() { return version; }

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

   @Override /* Overridden from OpenApiElement */
   public Info set(String property, Object value) {
      reqnn("property", property);
      return switch (property) {
         case "contact" -> setContact(toType(value, Contact.class));
         case "description" -> setDescription(s(value));
         case "license" -> setLicense(toType(value, License.class));
         case "siteName" -> setSiteName(s(value));
         case "termsOfService" -> setTermsOfService(s(value));
         case "title" -> setTitle(s(value));
         case "version" -> setVersion(s(value));
         default -> {
            super.set(property, value);
            yield this;
         }
      };
   }

   /**
    * Bean property setter:  <property>contact</property>.
    *
    * <p>
    * The contact information for the exposed API.
    *
    * @param value
    *    The new value for this property.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public Info setContact(Contact value) {
      contact = value;
      return this;
   }

   /**
    * Bean property setter:  <property>description</property>.
    *
    * <p>
    * A short description of the application.
    *
    * @param value
    *    The new value for this property.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public Info setDescription(String value) {
      description = value;
      return this;
   }

   /**
    * Bean property setter:  <property>license</property>.
    *
    * <p>
    * The license information for the exposed API.
    *
    * @param value
    *    The new value for this property.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public Info setLicense(License value) {
      license = value;
      return this;
   }

   /**
    * Bean property setter:  <property>siteName</property>.
    *
    * <p>
    * The site name of the application.
    *
    * @param value
    *    The new value for this property.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public Info setSiteName(String value) {
      siteName = value;
      return this;
   }

   /**
    * Bean property setter:  <property>termsOfService</property>.
    *
    * <p>
    * The Terms of Service for the API.
    *
    * @param value
    *    The new value for this property.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public Info setTermsOfService(String value) {
      termsOfService = value;
      return this;
   }

   /**
    * Bean property setter:  <property>title</property>.
    *
    * <p>
    * The title of the application.
    *
    * @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 Info setTitle(String value) {
      title = value;
      return this;
   }

   /**
    * Bean property setter:  <property>version</property>.
    *
    * <p>
    * Provides the version of the application API (not to be confused with the specification version).
    *
    * @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 Info setVersion(String value) {
      version = value;
      return this;
   }

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

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