/*
 * 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.marshall.xml;

import static org.apache.juneau.commons.utils.CollectionUtils.*;
import static org.apache.juneau.commons.utils.Shorts.*;

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

/**
 * Metadata on bean properties specific to the XML serializers and parsers pulled from the {@link Xml @Xml} annotation
 * on the bean property.
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/XmlSupport">XML</a>
 * </ul>
 */
public class XmlBeanPropertyMeta extends ExtendedBeanPropertyMeta {

   /**
    * Default instance.
    */
   public static final XmlBeanPropertyMeta DEFAULT = new XmlBeanPropertyMeta();

   private Namespace namespace;
   private XmlFormat xmlFormat = XmlFormat.DEFAULT;
   private String childName;
   private final XmlMetaProvider xmlMetaProvider;

   /**
    * Constructor.
    *
    * @param bpm The metadata of the bean property of this additional metadata.
    *    <br>Must not be <jk>null</jk>.
    * @param mp XML metadata provider (for finding information about other artifacts).
    *    <br>Must not be <jk>null</jk>.
    */
   public XmlBeanPropertyMeta(BeanPropertyMeta bpm, XmlMetaProvider mp) {
      super(bpm);
      this.xmlMetaProvider = mp;

      bpm.getAnnotations(Xml.class).forEach(x -> findXmlInfo(x.inner(), ((ClassMeta<?>) bpm.getBeanInfo()).getMarshallingContext().getAnnotationProvider()));

      if (namespace == null)
         namespace = mp.getXmlClassMeta((ClassMeta<?>) bpm.getBeanMeta().getBeanInfo()).getNamespace();
   }

   private XmlBeanPropertyMeta() {
      super(null);
      this.xmlMetaProvider = null;
   }

   /**
    * Returns the child element of this property from the {@link Xml#childName} annotation on this bean property.
    *
    * @return The child element, or <jk>null</jk> if annotation not specified.
    */
   public String getChildName() { return childName; }

   /**
    * Returns the XML namespace associated with this bean property.
    *
    * <p>
    * Namespace is determined in the following order of {@link Xml#prefix() @Xml(prefix)} annotation:
    * <ol>
    *    <li>Bean property field.
    *    <li>Bean getter.
    *    <li>Bean setter.
    *    <li>Bean class.
    *    <li>Bean package.
    *    <li>Bean superclasses.
    *    <li>Bean superclass packages.
    *    <li>Bean interfaces.
    *    <li>Bean interface packages.
    * </ol>
    *
    * @return The namespace associated with this bean property, or <jk>null</jk> if no namespace is associated with it.
    */
   public Namespace getNamespace() { return namespace; }

   /**
    * Returns the XML format of this property from the {@link Xml#format} annotation on this bean property.
    *
    * @return The XML format, or {@link XmlFormat#DEFAULT} if annotation not specified.
    */
   public XmlFormat getXmlFormat() { return xmlFormat; }

   @SuppressWarnings({
      "java:S1172", // mp unused here; accepted to match AnnotationProvider-based caller pattern
      "java:S3776", // Cognitive complexity acceptable for XML format detection from annotations
      "unused" // mp unused here; accepted to match AnnotationProvider-based caller pattern
   })
   private void findXmlInfo(Xml xml, AnnotationProvider mp) {
      if (xml == null)
         return;
      var bpm = getBeanPropertyMeta();
      var cmProperty = (ClassMeta<?>) bpm.getBeanInfo();
      var cmBean = (ClassMeta<?>) bpm.getBeanMeta().getBeanInfo();
      var name = bpm.getName();

      var ap = cmProperty.getMarshallingContext().getAnnotationProvider();
      var xmls = new MultiList<>(
         rstream(ap.find(Xml.class, cmBean)).map(AnnotationInfo::inner).toList(),
         reverse(bpm.getAnnotations(Xml.class).map(AnnotationInfo::inner).toList())
      );
      var schemas = new MultiList<>(
         rstream(ap.find(XmlSchema.class, cmBean)).map(AnnotationInfo::inner).toList(),
         reverse(bpm.getAnnotations(XmlSchema.class).map(AnnotationInfo::inner).toList())
      );
      namespace = XmlUtils.findNamespace(xmls, schemas);

      if (xmlFormat == XmlFormat.DEFAULT)
         xmlFormat = xml.format();

      boolean isCollection = cmProperty.isCollectionOrArray();

      String cen = xml.childName();
      if ((! cen.isEmpty()) && (! isCollection))
         throw brex(cmProperty.inner(), "Annotation error on property '%s'.  @Xml.childName can only be specified on collections and arrays.", name);

      if (xmlFormat == XmlFormat.COLLAPSED) {
         if (isCollection) {
            if (cen.isEmpty() && nn(xmlMetaProvider))
               cen = xmlMetaProvider.getXmlClassMeta(cmProperty).getChildName();
         if (ie(cen))
            cen = cmProperty.getElementType().getBeanDictionaryName();
         if (ie(cen))
            cen = name;
         } else {
            throw brex(cmBean.inner(), "Annotation error on property '%s'.  @Xml.format=COLLAPSED can only be specified on collections and arrays.", name);
         }
         if (cen.isEmpty())
            cen = cmProperty.getBeanDictionaryName();
      }

      if (! cen.isEmpty())
         childName = cen;
   }
}