/*
 * 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.CollectionUtils.*;
import static org.apache.juneau.commons.utils.Shorts.*;
import static org.apache.juneau.marshall.internal.ConverterUtils.*;

import java.util.*;

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

/**
 * Describes a single request body.
 *
 * <p>
 * The Request Body Object describes a single request body that can be sent to an API operation. It includes
 * a description, whether the request body is required, and the content (media types) that the request body can contain.
 *
 * <h5 class='section'>OpenAPI Specification:</h5>
 * <p>
 * The Request Body Object is composed of the following fields:
 * <ul class='spaced-list'>
 *    <li><c>description</c> (string) - A brief description of the request body (CommonMark syntax may be used)
 *    <li><c>content</c> (map of {@link MediaType}, REQUIRED) - The content of the request body (keys are media types)
 *    <li><c>required</c> (boolean) - Determines if the request body is required in the request (default is <jk>false</jk>)
 * </ul>
 *
 * <h5 class='section'>Example:</h5>
 * <p class='bjava'>
 *    <jc>// Create a request body for JSON content</jc>
 *    RequestBodyInfo <jv>requestBody</jv> = <jk>new</jk> RequestBodyInfo()
 *       .setDescription(<js>"Pet object that needs to be added to the store"</js>)
 *       .setRequired(<jk>true</jk>)
 *       .setContent(
 *          JsonMap.<jsm>of</jsm>(
 *             <js>"application/json"</js>, <jk>new</jk> MediaType()
 *                .setSchema(
 *                   <jk>new</jk> SchemaInfo().setRef(<js>"#/components/schemas/Pet"</js>)
 *                )
 *          )
 *       );
 * </p>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://spec.openapis.org/oas/v3.0.0#request-body-object">OpenAPI Specification &gt; Request Body Object</a>
 *    <li class='link'><a class="doclink" href="https://swagger.io/docs/specification/describing-request-body/">OpenAPI Describing Request Body</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 RequestBodyInfo extends OpenApiElement {

   private String description;
   private final Map<String,MediaType> content = map();
   private Boolean required;

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

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

      this.description = copyFrom.description;
      this.required = copyFrom.required;
      content.putAll(cp(copyFrom.content, MediaType::copy));
   }

   /**
    * Adds one or more values to the <property>content</property> property.
    *
    * @param key The mapping key.  Must not be <jk>null</jk>, or an {@link IllegalArgumentException} is thrown.
    * @param value
    *    The values to add to this property.
    *    <br>Must not be <jk>null</jk>, or an {@link IllegalArgumentException} is thrown.
    *    <br>Ignored if <jk>null</jk>.
    * @return This object
    */
   public RequestBodyInfo addContent(String key, MediaType value) {
      reqnn("key", key);
      reqnn("value", value);
      content.put(key, value);
      return this;
   }

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

   @Override /* Overridden from OpenApiElement */
   public <T> T get(String property, Class<T> type) {
      reqnn("property", property);
      return switch (property) {
         case "description" -> toType(getDescription(), type);
         case "content" -> toType(getContent(), type);
         case "required" -> toType(getRequired(), type);
         default -> super.get(property, type);
      };
   }

   /**
    * Bean property getter:  <property>content</property>.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public Map<String,MediaType> getContent() { return nie(content); }

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

   /**
    * Bean property getter:  <property>required</property>.
    *
    * <p>
    * Determines if the request body is required in the request.
    *
    * @return The property value, or <jk>null</jk> if it is not set.
    */
   public Boolean getRequired() { return required; }

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

   @Override /* Overridden from OpenApiElement */
   public RequestBodyInfo set(String property, Object value) {
      reqnn("property", property);
      return switch (property) {
         case "content" -> setContent(toMapBuilder(value, String.class, MediaType.class).sparse().build());
         case "description" -> setDescription(s(value));
         case "required" -> setRequired(toBoolean(value));
         default -> {
            super.set(property, value);
            yield this;
         }
      };
   }

   /**
    * Bean property setter:  <property>content</property>.
    *
    * @param value
    *    The new value for this property.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public RequestBodyInfo setContent(Map<String,MediaType> value) {
      content.clear();
      if (nn(value))
         content.putAll(value);
      return this;
   }

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

   /**
    * Bean property setter:  <property>required</property>.
    *
    * <p>
    * Determines if the request body is required in the request.
    *
    * @param value
    *    The new value for this property.
    *    <br>Can be <jk>null</jk> to unset the property.
    * @return This object
    */
   public RequestBodyInfo setRequired(Boolean value) {
      required = value;
      return this;
   }

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

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