/*
 * 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.bean.*;
import org.apache.juneau.marshall.*;
import org.apache.juneau.marshall.collections.*;
import org.apache.juneau.marshall.marshaller.*;

/**
 * Root class for all Swagger beans.
 */
@Marshalled
@SuppressWarnings({
   "java:S1192" // Duplicated literals (argument/property names) read more clearly inline than as constants
})
public abstract class OpenApiElement {

   private boolean strict;
   private Map<String,Object> extra;

   OpenApiElement() {}

   OpenApiElement(OpenApiElement copyFrom) {
      this.strict = copyFrom.strict;
      this.extra = cp(copyFrom.extra);
   }

   /**
    * Returns a copy of this swagger element as a modifiable map.
    *
    * <p>
    * Each call produces a new map.
    *
    * @return A map containing all the values in this swagger element.
    */
   public JsonMap asMap() {
      var m = new JsonMap();
      for (var s : keySet())
         m.put(s, get(s, Object.class));
      return m;
   }

   /**
    * Generic property keyset.
    *
    * @return
    *    All the non-standard keys on this element.
    *    <br>Never <jk>null</jk>.
    */
   @BeanProp("*")
   public Set<String> extraKeys() {
      return extra == null ? Collections.emptySet() : u(extra.keySet());
   }

   /**
    * Generic property getter.
    *
    * <p>
    * Can be used to retrieve non-standard Swagger fields such as <js>"$ref"</js>.
    *
    * @param property The property name to retrieve.  Must not be <jk>null</jk>, or an {@link IllegalArgumentException} is thrown.
    * @return The property value, or <jk>null</jk> if the property does not exist or is not set.
    */
   @BeanProp("*")
   public Object get(String property) {
      reqnn("property", property);
      return o(extra).map(x -> x.get(property)).orElse(null);
   }

   /**
    * Generic property getter.
    *
    * <p>
    * Can be used to retrieve non-standard Swagger fields such as <js>"$ref"</js>.
    *
    * @param property The property name to retrieve.
    * @param type The datatype to cast the value to.
    * @param <T> The datatype to cast the value to.
    * @return The property value, or <jk>null</jk> if the property does not exist or is not set.
    */
   public <T> T get(String property, Class<T> type) {
      reqnn("property", property);
      return toType(get(property), type);
   }

   /**
    * Returns all the keys on this element.
    *
    * @return
    *    All the keys on this element.
    *    <br>Never <jk>null</jk>.
    */
   public Set<String> keySet() {
      return extraKeys();
   }

   /**
    * Generic property setter.
    *
    * <p>
    * Can be used to set non-standard Swagger fields such as <js>"$ref"</js>.
    *
    * @param property The property name to set.  Must not be <jk>null</jk>, or an {@link IllegalArgumentException} is thrown.
    * @param value The new value for the property.
    * @return This object
    * @throws RuntimeException if strict mode is enabled.
    */
   @BeanProp("*")
   public OpenApiElement set(String property, Object value) {
      reqnn("property", property);
      if (strict)
         throw rex("Cannot set property '%s' in strict mode.", property);
      if (extra == null)
         extra = map();
      extra.put(property, value);
      return this;
   }

   @Override /* Overridden from Object */
   public String toString() {
      return Json.of(this);
   }

   /**
    * Returns <jk>true</jk> if contents should be validated per the Swagger spec.
    *
    * @return <jk>true</jk> if contents should be validated per the Swagger spec.
    */
   protected boolean isStrict() { return strict; }

   /**
    * Sets strict mode on this bean.
    *
    * @return This object
    */
   protected OpenApiElement strict() {
      strict = true;
      return this;
   }

   /**
    * Sets strict mode on this bean.
    *
    * @param value
    *    The new value for this property.
    *    <br>Non-boolean values will be converted to boolean using <code>Boolean.<jsm>valueOf</jsm>(value.toString())</code>.
    *    <br>Can be <jk>null</jk> (interpreted as <jk>false</jk>).
    * @return This object
    */
   protected OpenApiElement strict(Object value) {
      strict = nn(value) && toBoolean(value);
      return this;
   }
}