javax.xml.bind.JAXBContextFactory Maven / Gradle / Ivy
/*
* Copyright (c) 2015, 2018 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 javax.xml.bind;
import java.util.Map;
/**
* Factory that creates new JAXBContext 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 {@code JAXBContext} class.
*
*
* For semantics see {@link javax.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 {@linkplain java.lang.Module#isOpen open} to at least the {@code java.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):
*
* - No JAXB implementation was discovered
*
- Classes use JAXB annotations incorrectly
*
- Classes have colliding annotations (i.e., two classes with the same type name)
*
- The JAXB implementation was unable to locate
* provider-specific out-of-band information (such as additional
* files generated at the development time.)
*
- {@code classesToBeBound} are not open to {@code java.xml.bind} module
*
*
* @throws IllegalArgumentException
* if the parameter contains {@code null} (i.e., {@code newInstance(null,someMap);})
*
* @since 9, JAXB 2.3
*/
JAXBContext createContext(Class[] classesToBeBound,
Map properties ) throws JAXBException;
/**
*
* Create a new instance of a {@code JAXBContext} class.
*
*
* For semantics see {@link javax.xml.bind.JAXBContext#newInstance(String, ClassLoader, java.util.Map)}
*
*
* 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 {@linkplain java.lang.Module#isOpen open} to at least the {@code java.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
*
* - failure to locate either ObjectFactory.class or jaxb.index in the packages
* - an ambiguity among global elements contained in the contextPath
* - failure to locate a value for the context factory provider property
* - mixing schema derived packages from different providers on the same contextPath
* - packages are not open to {@code java.xml.bind} module
*
*
* @since 9, JAXB 2.3
*/
JAXBContext createContext(String contextPath,
ClassLoader classLoader,
Map properties ) throws JAXBException;
}