Package com.helger.jaxb.builder

Class AbstractJAXBBuilder<IMPLTYPE extends AbstractJAXBBuilder<IMPLTYPE>>

java.lang.Object
com.helger.jaxb.builder.AbstractJAXBBuilder<IMPLTYPE>
Type Parameters:
IMPLTYPE - The implementation class implementing this abstract class.
All Implemented Interfaces:
com.helger.commons.lang.IHasClassLoader, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>
Direct Known Subclasses:
AbstractWritingJAXBBuilder, JAXBReaderBuilder
@NotThreadSafe @Deprecated(forRemoval=true, since="11.0.3") public abstract class AbstractJAXBBuilder<IMPLTYPE extends AbstractJAXBBuilder<IMPLTYPE>> extends Object implements com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.lang.IHasClassLoader
Deprecated, for removal: This API element is subject to removal in a future version.
Abstract builder class for reading, writing and validating JAXB documents.
Author:
Philip Helger

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final IJAXBDocumentType
    m_aDocType
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractJAXBBuilder(IJAXBDocumentType aDocType)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<jakarta.xml.bind.JAXBException>>
    exceptionCallbacks()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    final ClassLoader
    getClassLoader()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected jakarta.xml.bind.JAXBContext
    getJAXBContext()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    final IJAXBDocumentType
    getJAXBDocumentType()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected final Schema
    getSchema()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    final boolean
    isUseJAXBContextCache()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    final boolean
    isUseSchema()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    final IMPLTYPE
    setUseJAXBContextCache(boolean bUseJAXBContextCache)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set usage of the JAXBContextCache.
    final IMPLTYPE
    setUseSchema(boolean bUseSchema)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set usage of XML Schema.
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

    thisAsT

    Methods inherited from interface com.helger.commons.lang.IHasClassLoader

    hasClassLoader

  • Field Details

    • m_aDocType

      protected final IJAXBDocumentType m_aDocType
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • AbstractJAXBBuilder

      protected AbstractJAXBBuilder(@Nonnull IJAXBDocumentType aDocType)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getJAXBDocumentType

      @Nonnull public final IJAXBDocumentType getJAXBDocumentType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      The document type as passed in the constructor. Never null.

    • getClassLoader

      @Nullable public final ClassLoader getClassLoader()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getClassLoader in interface com.helger.commons.lang.IHasClassLoader
      Returns:
      The special class loader to be used. null by default.

    • isUseJAXBContextCache

      public final boolean isUseJAXBContextCache()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      true if the JAXBContextCache is used, false if not. Default is true.

    • setUseJAXBContextCache

      @Nonnull public final IMPLTYPE setUseJAXBContextCache(boolean bUseJAXBContextCache)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set usage of the JAXBContextCache. For performance reasons it's recommended to use the cache.
      Parameters:
      bUseJAXBContextCache - true to use the cache, false to create a new JAXBContext every time.
      Returns:
      this

    • isUseSchema

      public final boolean isUseSchema()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      true if the XML Schema should be used to validate on unmarshalling, false if not. Default is true.
      Since:
      9.0.3

    • setUseSchema

      @Nonnull public final IMPLTYPE setUseSchema(boolean bUseSchema)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      Parameters:
      bUseSchema - true to use XML Schema, false to not do it.
      Returns:
      this
      Since:
      9.0.3

    • exceptionCallbacks

      @Nonnull @ReturnsMutableObject public final com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<jakarta.xml.bind.JAXBException>> exceptionCallbacks()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSchema

      @Nullable protected final Schema getSchema()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      The XML schema to be used for validating instances. May be null if no XSDs are present. Also null if

    • getJAXBContext

      @Nonnull @OverrideOnDemand protected jakarta.xml.bind.JAXBContext getJAXBContext() throws jakarta.xml.bind.JAXBException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      jakarta.xml.bind.JAXBException

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object