org.jboss.resteasy.plugins.providers.jaxb.JAXBContextFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of resteasy-jaxb-provider Show documentation

There is a newer version: 7.0.0.Alpha4

Show newest version

package org.jboss.resteasy.plugins.providers.jaxb;

import java.lang.annotation.Annotation;

import jakarta.ws.rs.core.MediaType;
import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;

/**
 * @author Bill Burke
 * @version $Revision: 1 $
 */
public interface JAXBContextFinder {
    /**
     * This method with find a JAXBContext for one type. The user can override the cache by defining
     * a ContextResolver{@literal <}JAXBContext{@literal >} for the given media type.
     *
     * @param type                 type
     * @param mediaType            media type
     * @param parameterAnnotations annotations
     * @return {@link JAXBContext}
     * @throws JAXBException jaxb exception
     */
    JAXBContext findCachedContext(Class type, MediaType mediaType, Annotation[] parameterAnnotations) throws JAXBException;

    /**
     * This method creates a JAXBContext from a collection of classes. Unlike the other findCachedContext() method,
     * the user cannot override the JAXBContext created.
     *
     * @param mediaType       media type
     * @param paraAnnotations annotations
     * @param classes         classes
     * @return {@link JAXBContext}
     * @throws JAXBException jaxb exception
     */
    JAXBContext findCacheContext(MediaType mediaType, Annotation[] paraAnnotations, Class... classes) throws JAXBException;

    /**
     * This method will find a JAXBContext from a set of XmlTypes that use an ObjectFactory for creation (i.e. from xjc).
     *
     * @param mediaType       media type
     * @param paraAnnotations annotations
     * @param classes         classes
     * @return {@link JAXBContext}
     * @throws JAXBException jaxb exception
     */
    JAXBContext findCacheXmlTypeContext(MediaType mediaType, Annotation[] paraAnnotations, Class... classes)
            throws JAXBException;

    JAXBContext createContext(Annotation[] parameterAnnotations, Class... classes) throws JAXBException;
}