com.helger.jaxb.builder.AbstractJAXBBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-jaxb Show documentation
Special Java 1.8+ Library with extended JAXB support
The newest version!
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.jaxb.builder;

import java.lang.ref.WeakReference;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import javax.xml.validation.Schema;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.OverrideOnDemand;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.callback.CallbackList;
import com.helger.commons.callback.exception.IExceptionCallback;
import com.helger.commons.lang.IHasClassLoader;
import com.helger.commons.string.ToStringGenerator;
import com.helger.commons.traits.IGenericImplTrait;
import com.helger.jaxb.JAXBContextCache;

import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;

/**
 * Abstract builder class for reading, writing and validating JAXB documents.
 *
 * @author Philip Helger
 * @param 
 *        The implementation class implementing this abstract class.
 */
@NotThreadSafe
@Deprecated (forRemoval = true, since = "11.0.3")
public abstract class AbstractJAXBBuilder > implements
                                          IGenericImplTrait ,
                                          IHasClassLoader
{
  protected final IJAXBDocumentType m_aDocType;
  private final WeakReference  m_aClassLoader;
  private boolean m_bUseJAXBContextCache = JAXBBuilderDefaultSettings.isDefaultUseContextCache ();
  private boolean m_bUseSchema = true;
  private final CallbackList > m_aExceptionCallbacks = new CallbackList <> ();

  protected AbstractJAXBBuilder (@Nonnull final IJAXBDocumentType aDocType)
  {
    m_aDocType = ValueEnforcer.notNull (aDocType, "DocType");
    // By default this class loader of the type to be marshalled should be used
    // This is important for OSGI application containers and ANT tasks
    m_aClassLoader = new WeakReference <> (aDocType.getImplementationClass ().getClassLoader ());
  }

  /**
   * @return The document type as passed in the constructor. Never
   *         null.
   */
  @Nonnull
  public final IJAXBDocumentType getJAXBDocumentType ()
  {
    return m_aDocType;
  }

  /**
   * @return The special class loader to be used. null by default.
   */
  @Nullable
  public final ClassLoader getClassLoader ()
  {
    return m_aClassLoader.get ();
  }

  /**
   * @return true if the {@link JAXBContextCache} is used,
   *         false if not. Default is true.
   */
  public final boolean isUseJAXBContextCache ()
  {
    return m_bUseJAXBContextCache;
  }

  /**
   * Set usage of the {@link JAXBContextCache}. For performance reasons it's
   * recommended to use the cache.
   *
   * @param bUseJAXBContextCache
   *        true to use the cache, false to create a
   *        new {@link JAXBContext} every time.
   * @return this
   */
  @Nonnull
  public final IMPLTYPE setUseJAXBContextCache (final boolean bUseJAXBContextCache)
  {
    m_bUseJAXBContextCache = bUseJAXBContextCache;
    return thisAsT ();
  }

  /**
   * @return true if the XML Schema should be used to validate on
   *         unmarshalling, false if not. Default is
   *         true.
   * @since 9.0.3
   */
  public final boolean isUseSchema ()
  {
    return m_bUseSchema;
  }

  /**
   * Set usage of XML Schema. By default it is enabled, but for rare cases it
   * could make sense to disable validation e.g. because of performance reasons.
   *
   * @param bUseSchema
   *        true to use XML Schema, false to not do
   *        it.
   * @return this
   * @since 9.0.3
   */
  @Nonnull
  public final IMPLTYPE setUseSchema (final boolean bUseSchema)
  {
    m_bUseSchema = bUseSchema;
    return thisAsT ();
  }

  @Nonnull
  @ReturnsMutableObject
  public final CallbackList > exceptionCallbacks ()
  {
    return m_aExceptionCallbacks;
  }

  /**
   * @return The XML schema to be used for validating instances. May be
   *         null if no XSDs are present. Also null if
   */
  @Nullable
  protected final Schema getSchema ()
  {
    if (m_bUseSchema)
      return m_aDocType.getSchema ();

    return null;
  }

  @Nonnull
  @OverrideOnDemand
  protected JAXBContext getJAXBContext () throws JAXBException
  {
    if (m_bUseJAXBContextCache)
    {
      // Since creating the JAXB context is quite cost intensive this is done
      // only once!
      return JAXBContextCache.getInstance ().getFromCache (m_aDocType.getImplementationClass (), getClassLoader ());
    }

    // Create a new JAXBContext - inefficient
    return JAXBContext.newInstance (m_aDocType.getImplementationClass ().getPackage ().getName (), getClassLoader ());
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("DocType", m_aDocType)
                                       .appendIfNotNull ("ClassLoader", m_aClassLoader)
                                       .append ("UseJAXBContextCache", m_bUseJAXBContextCache)
                                       .append ("UseSchema", m_bUseSchema)
                                       .append ("ExceptionHandler", m_aExceptionCallbacks)
                                       .getToString ();
  }
}