https://github.com/eclipse-ee4j/jaxb-api/jakarta.xml.bind-api: Jakarta XML Binding API (Eclipse Foundation)
  • Roman Grigoriadi (Oracle Corporation) 
/*
 * Copyright (c) 2015, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package jakarta.xml.bind;

import java.util.Map;


Factory that creates new JAXBContext instances. JAXBContextFactory can be located using ServiceLoader.load(Class<Object>) 
Since:9, JAXB 2.3
/**
 * <p>Factory that creates new <code>JAXBContext</code> instances.
 *
 * JAXBContextFactory can be located using {@link java.util.ServiceLoader#load(Class)}
 *
 * @since 9, JAXB 2.3
 */
public interface JAXBContextFactory {

    
 Create a new instance of a JAXBContext class. 
 For semantics see JAXBContext.newInstance(Class<?>[], Map<String,?>) 
Params:
  • classesToBeBound –  List of java classes to be recognized by the new JAXBContext. Classes in classesToBeBound that are in named modules must be in a package that is open to at least the jakarta.xml.bind module. Can be empty, in which case a JAXBContext that only knows about spec-defined classes will be returned.
  • properties – 
     provider-specific properties. Can be null, which means the same thing as passing
     in an empty map.
Throws:
  • JAXBException –  if an error was encountered while creating the JAXBContext, such as (but not limited to): 
      
 
    1. No Jakarta XML Binding implementation was discovered
 
    2. Classes use Jakarta XML Binding annotations incorrectly
 
    3. Classes have colliding annotations (i.e., two classes with the same type name)
 
    4. The Jakarta XML Binding implementation was unable to locate
     provider-specific out-of-band information (such as additional
     files generated at the development time.)
 
    5. classesToBeBound are not open to jakarta.xml.bind module 
  • IllegalArgumentException –  if the parameter contains null (i.e., newInstance(null,someMap);)
Returns: A new instance of a JAXBContext.
Since:9, JAXB 2.3
/**
     * <p>
     * Create a new instance of a {@code JAXBContext} class.
     *
     * <p>
     * For semantics see {@link jakarta.xml.bind.JAXBContext#newInstance(Class[], java.util.Map)}
     *
     * @param classesToBeBound
     *      List of java classes to be recognized by the new {@link JAXBContext}.
     *      Classes in {@code classesToBeBound} that are in named modules must be in a package
     *      that is {@code open} to at least the {@code jakarta.xml.bind} module.
     *      Can be empty, in which case a {@link JAXBContext} that only knows about
     *      spec-defined classes will be returned.
     * @param properties
     *      provider-specific properties. Can be null, which means the same thing as passing
     *      in an empty map.
     *
     * @return
     *      A new instance of a {@code JAXBContext}.
     *
     * @throws JAXBException
     *      if an error was encountered while creating the
     *      {@code JAXBContext}, such as (but not limited to):
     * <ol>
     *  <li>No Jakarta XML Binding implementation was discovered
     *  <li>Classes use Jakarta XML Binding annotations incorrectly
     *  <li>Classes have colliding annotations (i.e., two classes with the same type name)
     *  <li>The Jakarta XML Binding implementation was unable to locate
     *      provider-specific out-of-band information (such as additional
     *      files generated at the development time.)
     *  <li>{@code classesToBeBound} are not open to {@code jakarta.xml.bind} module
     * </ol>
     *
     * @throws IllegalArgumentException
     *      if the parameter contains {@code null} (i.e., {@code newInstance(null,someMap);})
     *
     * @since 9, JAXB 2.3
     */
    JAXBContext createContext(Class<?>[] classesToBeBound,
                              Map<String, ?> properties ) throws JAXBException;

    
 Create a new instance of a JAXBContext class. 
 For semantics see JAXBContext.newInstance(String, ClassLoader, Map<String,?>) 
 The interpretation of properties is up to implementations. Implementations must throw JAXBException if it finds properties that it doesn't understand. 
Params:
  • contextPath –  List of java package names that contain schema derived classes. Classes in classesToBeBound that are in named modules must be in a package that is open to at least the jakarta.xml.bind module.
  • classLoader – 
     This class loader will be used to locate the implementation classes.
  • properties – 
     provider-specific properties. Can be null, which means the same thing as passing
     in an empty map.
Throws:
  • JAXBException – if an error was encountered while creating the JAXBContext such as 
      
  
    1. failure to locate either ObjectFactory.class or jaxb.index in the packages
      2. 
  
    2. an ambiguity among global elements contained in the contextPath
      3. 
  
    3. failure to locate a value for the context factory provider property
      4. 
  
    4. mixing schema derived packages from different providers on the same contextPath
      5. 
  
    5. packages are not open to jakarta.xml.bind module
      6. 

Returns:a new instance of a JAXBContext
Since:9, JAXB 2.3
/**
     * <p>
     * Create a new instance of a {@code JAXBContext} class.
     *
     * <p>
     * For semantics see {@link jakarta.xml.bind.JAXBContext#newInstance(String, ClassLoader, java.util.Map)}
     *
     * <p>
     * The interpretation of properties is up to implementations. Implementations must
     * throw {@code JAXBException} if it finds properties that it doesn't understand.
     *
     * @param contextPath
     *      List of java package names that contain schema derived classes.
     *      Classes in {@code classesToBeBound} that are in named modules must be in a package
     *      that is {@code open} to at least the {@code jakarta.xml.bind} module.
     * @param classLoader
     *      This class loader will be used to locate the implementation classes.
     * @param properties
     *      provider-specific properties. Can be null, which means the same thing as passing
     *      in an empty map.
     *
     * @return a new instance of a {@code JAXBContext}
     * @throws JAXBException if an error was encountered while creating the
     *                       {@code JAXBContext} such as
     * <ol>
     *   <li>failure to locate either ObjectFactory.class or jaxb.index in the packages</li>
     *   <li>an ambiguity among global elements contained in the contextPath</li>
     *   <li>failure to locate a value for the context factory provider property</li>
     *   <li>mixing schema derived packages from different providers on the same contextPath</li>
     *   <li>packages are not open to {@code jakarta.xml.bind} module</li>
     * </ol>
     *
     * @since 9, JAXB 2.3
     */
    JAXBContext createContext(String contextPath,
                              ClassLoader classLoader,
                              Map<String, ?> properties ) throws JAXBException;

}