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

import static org.apache.juneau.collections.JsonMap.*;
import static org.apache.juneau.common.internal.ThrowableUtils.*;

import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import java.util.concurrent.*;

import javax.xml.stream.*;
import javax.xml.stream.util.*;

import org.apache.juneau.*;
import org.apache.juneau.collections.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.parser.*;
import org.apache.juneau.utils.*;

/**
 * Parses text generated by the {@link XmlSerializer} class back into a POJO model.
 *
 * <h5 class='topic'>Media types</h5>
 * <p>
 * Handles <c>Content-Type</c> types:  <bc>text/xml</bc>
 *
 * <h5 class='topic'>Description</h5>
 * <p>
 * See the {@link XmlSerializer} class for a description of Juneau-generated XML.
 *
 * <h5 class='section'>Notes:</h5><ul>
 *    <li class='note'>This class is thread safe and reusable.
 * </ul>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.XmlDetails">XML Details</a>

 * </ul>
 */
public class XmlParser extends ReaderParser implements XmlMetaProvider {

   //-------------------------------------------------------------------------------------------------------------------
   // Static
   //-------------------------------------------------------------------------------------------------------------------

   /** Default parser, all default settings.*/
   public static final XmlParser DEFAULT = new XmlParser(create());

   /**
    * Creates a new builder for this object.
    *
    * @return A new builder.
    */
   public static Builder create() {
      return new Builder();
   }

   //-------------------------------------------------------------------------------------------------------------------
   // Builder
   //-------------------------------------------------------------------------------------------------------------------

   /**
    * Builder class.
    */
   @FluentSetters
   public static class Builder extends ReaderParser.Builder {

      private static final Cache<HashKey,XmlParser> CACHE = Cache.of(HashKey.class, XmlParser.class).build();

      boolean preserveRootElement, validating;
      Class<? extends XMLEventAllocator> eventAllocator;
      Class<? extends XMLReporter> reporter;
      Class<? extends XMLResolver> resolver;

      /**
       * Constructor, default settings.
       */
      protected Builder() {
         super();
         consumes("text/xml,application/xml");
         preserveRootElement = env("XmlParser.preserveRootElement", false);
         validating = env("XmlParser.validating", false);
         eventAllocator = null;
         reporter = null;
         resolver = null;
      }

      /**
       * Copy constructor.
       *
       * @param copyFrom The bean to copy from.
       */
      protected Builder(XmlParser copyFrom) {
         super(copyFrom);
         preserveRootElement = copyFrom.preserveRootElement;
         validating = copyFrom.validating;
         eventAllocator = copyFrom.eventAllocator;
         reporter = copyFrom.reporter;
         resolver = copyFrom.resolver;
      }

      /**
       * Copy constructor.
       *
       * @param copyFrom The builder to copy from.
       */
      protected Builder(Builder copyFrom) {
         super(copyFrom);
         preserveRootElement = copyFrom.preserveRootElement;
         validating = copyFrom.validating;
         eventAllocator = copyFrom.eventAllocator;
         reporter = copyFrom.reporter;
         resolver = copyFrom.resolver;
      }

      @Override /* Context.Builder */
      public Builder copy() {
         return new Builder(this);
      }

      @Override /* Context.Builder */
      public XmlParser build() {
         return cache(CACHE).build(XmlParser.class);
      }

      @Override /* Context.Builder */
      public HashKey hashKey() {
         return HashKey.of(
            super.hashKey(),
            preserveRootElement,
            validating,
            eventAllocator,
            reporter,
            resolver
         );
      }

      //-----------------------------------------------------------------------------------------------------------------
      // Properties
      //-----------------------------------------------------------------------------------------------------------------

      /**
       * XML event allocator.
       *
       * <p>
       * Associates an {@link XMLEventAllocator} with this parser.
       *
       * @param value The new value for this property.
       * @return This object.
       */
      @FluentSetter
      public Builder eventAllocator(Class<? extends XMLEventAllocator> value) {
         eventAllocator = value;
         return this;
      }

      /**
       * Preserve root element during generalized parsing.
       *
       * <p>
       * When enabled, when parsing into a generic {@link JsonMap}, the map will contain a single entry whose key
       * is the root element name.
       *
       * <h5 class='section'>Example:</h5>
       * <p class='bjava'>
       *    <jc>// Parser with preserve-root-element.</jc>
       *    ReaderParser <jv>parser1</jv> = XmlParser
       *       .<jsm>create</jsm>()
       *       .preserveRootElement()
       *       .build();
       *
       *    <jc>// Parser without preserve-root-element (the default behavior).</jc>
       *    ReaderParser <jv>parser2</jv> = XmlParser
       *       .<jsm>create</jsm>()
       *       .build();
       *
       *    String <jv>xml</jv> = <js>"&lt;root&gt;&lt;a&gt;foobar&lt;/a&gt;&lt;/root&gt;"</js>;
       *
       *    <jc>// Produces:  "{ root: { a:'foobar' }}"</jc>
       *    JsonMap <jv>map1</jv> = <jv>parser1</jv>.parse(<jv>xml</jv>, JsonMap.<jk>class</jk>);
       *
       *    <jc>// Produces:  "{ a:'foobar' }"</jc>
       *    JsonMap <jv>map2</jv> = <jv>parser2</jv>.parse(<jv>xml</jv>, JsonMap.<jk>class</jk>);
       * </p>
       *
       * @return This object.
       */
      @FluentSetter
      public Builder preserveRootElement() {
         return preserveRootElement(true);
      }

      /**
       * Same as {@link #preserveRootElement()} but allows you to explicitly specify the value.
       *
       * @param value The value for this setting.
       * @return This object.
       */
      @FluentSetter
      public Builder preserveRootElement(boolean value) {
         preserveRootElement = value;
         return this;
      }

      /**
       * XML reporter.
       *
       * <p>
       * Associates an {@link XMLReporter} with this parser.
       *
       * @param value The new value for this property.
       * @return This object.
       */
      @FluentSetter
      public Builder reporter(Class<? extends XMLReporter> value) {
         reporter = value;
         return this;
      }

      /**
       * XML resolver.
       *
       * <p>
       * Associates an {@link XMLResolver} with this parser.
       *
       * @param value The new value for this property.
       * @return This object.
       */
      @FluentSetter
      public Builder resolver(Class<? extends XMLResolver> value) {
         resolver = value;
         return this;
      }

      /**
       * Enable validation.
       *
       * <p>
       * If <jk>true</jk>, XML document will be validated.
       *
       * <p>
       * See {@link XMLInputFactory#IS_VALIDATING} for more info.
       *
       * @return This object.
       */
      @FluentSetter
      public Builder validating() {
         return validating(true);
      }

      /**
       * Same as {@link #validating()} but allows you to explicitly specify the value.
       *
       * @param value The value for this setting.
       * @return This object.
       */
      @FluentSetter
      public Builder validating(boolean value) {
         validating = value;
         return this;
      }

      // <FluentSetters>

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder annotations(Annotation...values) {
         super.annotations(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder apply(AnnotationWorkList work) {
         super.apply(work);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder applyAnnotations(java.lang.Class<?>...fromClasses) {
         super.applyAnnotations(fromClasses);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder applyAnnotations(Method...fromMethods) {
         super.applyAnnotations(fromMethods);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder cache(Cache<HashKey,? extends org.apache.juneau.Context> value) {
         super.cache(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder debug() {
         super.debug();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder debug(boolean value) {
         super.debug(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder impl(Context value) {
         super.impl(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.Context.Builder */
      public Builder type(Class<? extends org.apache.juneau.Context> value) {
         super.type(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanClassVisibility(Visibility value) {
         super.beanClassVisibility(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanConstructorVisibility(Visibility value) {
         super.beanConstructorVisibility(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanContext(BeanContext value) {
         super.beanContext(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanContext(BeanContext.Builder value) {
         super.beanContext(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanDictionary(java.lang.Class<?>...values) {
         super.beanDictionary(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanFieldVisibility(Visibility value) {
         super.beanFieldVisibility(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.swap.BeanInterceptor<?>> value) {
         super.beanInterceptor(on, value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanMapPutReturnsOldValue() {
         super.beanMapPutReturnsOldValue();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanMethodVisibility(Visibility value) {
         super.beanMethodVisibility(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanProperties(Map<String,Object> values) {
         super.beanProperties(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanProperties(Class<?> beanClass, String properties) {
         super.beanProperties(beanClass, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanProperties(String beanClassName, String properties) {
         super.beanProperties(beanClassName, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesExcludes(Map<String,Object> values) {
         super.beanPropertiesExcludes(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesExcludes(Class<?> beanClass, String properties) {
         super.beanPropertiesExcludes(beanClass, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesExcludes(String beanClassName, String properties) {
         super.beanPropertiesExcludes(beanClassName, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesReadOnly(Map<String,Object> values) {
         super.beanPropertiesReadOnly(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesReadOnly(Class<?> beanClass, String properties) {
         super.beanPropertiesReadOnly(beanClass, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesReadOnly(String beanClassName, String properties) {
         super.beanPropertiesReadOnly(beanClassName, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesWriteOnly(Map<String,Object> values) {
         super.beanPropertiesWriteOnly(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesWriteOnly(Class<?> beanClass, String properties) {
         super.beanPropertiesWriteOnly(beanClass, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beanPropertiesWriteOnly(String beanClassName, String properties) {
         super.beanPropertiesWriteOnly(beanClassName, properties);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beansRequireDefaultConstructor() {
         super.beansRequireDefaultConstructor();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beansRequireSerializable() {
         super.beansRequireSerializable();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder beansRequireSettersForGetters() {
         super.beansRequireSettersForGetters();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
         super.dictionaryOn(on, values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder disableBeansRequireSomeProperties() {
         super.disableBeansRequireSomeProperties();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder disableIgnoreMissingSetters() {
         super.disableIgnoreMissingSetters();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder disableIgnoreTransientFields() {
         super.disableIgnoreTransientFields();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder disableIgnoreUnknownNullBeanProperties() {
         super.disableIgnoreUnknownNullBeanProperties();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder disableInterfaceProxies() {
         super.disableInterfaceProxies();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public <T> Builder example(Class<T> pojoClass, T o) {
         super.example(pojoClass, o);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public <T> Builder example(Class<T> pojoClass, String json) {
         super.example(pojoClass, json);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder findFluentSetters() {
         super.findFluentSetters();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder findFluentSetters(Class<?> on) {
         super.findFluentSetters(on);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder ignoreInvocationExceptionsOnGetters() {
         super.ignoreInvocationExceptionsOnGetters();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder ignoreInvocationExceptionsOnSetters() {
         super.ignoreInvocationExceptionsOnSetters();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder ignoreUnknownBeanProperties() {
         super.ignoreUnknownBeanProperties();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder ignoreUnknownEnumValues() {
         super.ignoreUnknownEnumValues();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder implClass(Class<?> interfaceClass, Class<?> implClass) {
         super.implClass(interfaceClass, implClass);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder implClasses(Map<Class<?>,Class<?>> values) {
         super.implClasses(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder interfaceClass(Class<?> on, Class<?> value) {
         super.interfaceClass(on, value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder interfaces(java.lang.Class<?>...value) {
         super.interfaces(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder locale(Locale value) {
         super.locale(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder mediaType(MediaType value) {
         super.mediaType(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder notBeanClasses(java.lang.Class<?>...values) {
         super.notBeanClasses(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder notBeanPackages(String...values) {
         super.notBeanPackages(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
         super.propertyNamer(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
         super.propertyNamer(on, value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder sortProperties() {
         super.sortProperties();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder sortProperties(java.lang.Class<?>...on) {
         super.sortProperties(on);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder stopClass(Class<?> on, Class<?> value) {
         super.stopClass(on, value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public <T, S> Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction) {
         super.swap(normalClass, swappedClass, swapFunction);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public <T, S> Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction, ThrowingFunction<S,T> unswapFunction) {
         super.swap(normalClass, swappedClass, swapFunction, unswapFunction);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder swaps(java.lang.Class<?>...values) {
         super.swaps(values);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder timeZone(TimeZone value) {
         super.timeZone(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder typeName(Class<?> on, String value) {
         super.typeName(on, value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder typePropertyName(String value) {
         super.typePropertyName(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder typePropertyName(Class<?> on, String value) {
         super.typePropertyName(on, value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder useEnumNames() {
         super.useEnumNames();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
      public Builder useJavaBeanIntrospector() {
         super.useJavaBeanIntrospector();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder autoCloseStreams() {
         super.autoCloseStreams();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder autoCloseStreams(boolean value) {
         super.autoCloseStreams(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder consumes(String value) {
         super.consumes(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder debugOutputLines(int value) {
         super.debugOutputLines(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder listener(Class<? extends org.apache.juneau.parser.ParserListener> value) {
         super.listener(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder strict() {
         super.strict();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder strict(boolean value) {
         super.strict(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder trimStrings() {
         super.trimStrings();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder trimStrings(boolean value) {
         super.trimStrings(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder unbuffered() {
         super.unbuffered();
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */
      public Builder unbuffered(boolean value) {
         super.unbuffered(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.ReaderParser.Builder */
      public Builder fileCharset(Charset value) {
         super.fileCharset(value);
         return this;
      }

      @Override /* GENERATED - org.apache.juneau.parser.ReaderParser.Builder */
      public Builder streamCharset(Charset value) {
         super.streamCharset(value);
         return this;
      }

      // </FluentSetters>
   }

   //-------------------------------------------------------------------------------------------------------------------
   // Instance
   //-------------------------------------------------------------------------------------------------------------------

   final boolean
      validating,
      preserveRootElement;
   final Class<? extends XMLEventAllocator> eventAllocator;
   final Class<? extends XMLReporter> reporter;
   final Class<? extends XMLResolver> resolver;

   private final XMLReporter reporterImpl;
   private final XMLResolver resolverImpl;
   private final XMLEventAllocator eventAllocatorImpl;
   private final Map<ClassMeta<?>,XmlClassMeta> xmlClassMetas = new ConcurrentHashMap<>();
   private final Map<BeanMeta<?>,XmlBeanMeta> xmlBeanMetas = new ConcurrentHashMap<>();
   private final Map<BeanPropertyMeta,XmlBeanPropertyMeta> xmlBeanPropertyMetas = new ConcurrentHashMap<>();

   /**
    * Constructor.
    *
    * @param builder
    *    The property store containing all the settings for this object.
    */
   public XmlParser(Builder builder) {
      super(builder);
      validating = builder.validating;
      preserveRootElement = builder.preserveRootElement;
      reporter = builder.reporter;
      resolver = builder.resolver;
      eventAllocator = builder.eventAllocator;

      reporterImpl = reporter != null ? newInstance(reporter) : null;
      resolverImpl = resolver != null ? newInstance(resolver) : null;
      eventAllocatorImpl = eventAllocator != null ? newInstance(eventAllocator) : null;
   }

   @Override /* Context */
   public Builder copy() {
      return new Builder(this);
   }

   @Override /* Context */
   public XmlParserSession.Builder createSession() {
      return XmlParserSession.create(this);
   }

   @Override /* Context */
   public XmlParserSession getSession() {
      return createSession().build();
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Extended metadata
   //-----------------------------------------------------------------------------------------------------------------

   @Override /* XmlMetaProvider */
   public XmlClassMeta getXmlClassMeta(ClassMeta<?> cm) {
      XmlClassMeta m = xmlClassMetas.get(cm);
      if (m == null) {
         m = new XmlClassMeta(cm, this);
         xmlClassMetas.put(cm, m);
      }
      return m;
   }

   @Override /* XmlMetaProvider */
   public XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm) {
      XmlBeanMeta m = xmlBeanMetas.get(bm);
      if (m == null) {
         m = new XmlBeanMeta(bm, this);
         xmlBeanMetas.put(bm, m);
      }
      return m;
   }

   @Override /* XmlMetaProvider */
   public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm) {
      XmlBeanPropertyMeta m = xmlBeanPropertyMetas.get(bpm);
      if (m == null) {
         BeanPropertyMeta dbpm = bpm.getDelegateFor();
         m = new XmlBeanPropertyMeta(dbpm, this);
         xmlBeanPropertyMetas.put(bpm, m);
      }
      return m;
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Properties
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * XML event allocator.
    *
    * @see Builder#eventAllocator(Class)
    * @return
    *    The {@link XMLEventAllocator} associated with this parser, or <jk>null</jk> if there isn't one.
    */
   protected final XMLEventAllocator getEventAllocator() {
      return eventAllocatorImpl;
   }

   /**
    * Preserve root element during generalized parsing.
    *
    * @see Builder#preserveRootElement()
    * @return
    *    <jk>true</jk> if when parsing into a generic {@link JsonMap}, the map will contain a single entry whose key
    *    is the root element name.
    */
   protected final boolean isPreserveRootElement() {
      return preserveRootElement;
   }

   /**
    * XML reporter.
    *
    * @see Builder#reporter(Class)
    * @return
    *    The {@link XMLReporter} associated with this parser, or <jk>null</jk> if there isn't one.
    */
   protected final XMLReporter getReporter() {
      return reporterImpl;
   }

   /**
    * XML resolver.
    *
    * @see Builder#resolver(Class)
    * @return
    *    The {@link XMLResolver} associated with this parser, or <jk>null</jk> if there isn't one.
    */
   protected final XMLResolver getResolver() {
      return resolverImpl;
   }

   /**
    * Enable validation.
    *
    * @see Builder#validating()
    * @return
    *    <jk>true</jk> if XML document will be validated.
    */
   protected final boolean isValidating() {
      return validating;
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Other methods
   //-----------------------------------------------------------------------------------------------------------------

   private <T> T newInstance(Class<T> c) {
      try {
         return c.getDeclaredConstructor().newInstance();
      } catch (Exception e) {
         throw asRuntimeException(e);
      }
   }

   @Override /* Context */
   protected JsonMap properties() {
      return filteredMap()
         .append("validating", validating)
         .append("preserveRootElement", preserveRootElement)
         .append("reporter", reporter)
         .append("resolver", resolver)
         .append("eventAllocator", eventAllocator);
   }
}