org.glassfish.hk2.xml.spi

Interface XmlServiceParser

All Known Implementing Classes:

DomXmlParser, JAXBXmlParser

@Contract
public interface XmlServiceParser

If an implementation of this exists it will be used to parse the XML file rather than the default implementation which uses JAXB

Author:

jwells

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PARSING_SERVICE The default Xml parsing service will have this name

Method Summary

Methods

Modifier and Type	Method and Description
PreGenerationRequirement	getPreGenerationRequirement() This tells the system whether or not it needs to pregenerate all proxies prior to parsing a document or if the proxies can be generated lazily
<T> T	parseRoot(Class<T> clazz, URI location, Unmarshaller.Listener listener) This method must return an instance of the given class as the root of an XML graph

Field Detail

DEFAULT_PARSING_SERVICE

static final String DEFAULT_PARSING_SERVICE

The default Xml parsing service will have this name

See Also:

Constant Field Values

Method Detail

parseRoot

<T> T parseRoot(Class<T> clazz,
              URI location,
              Unmarshaller.Listener listener)
            throws Exception

This method must return an instance of the given class as the root of an XML graph

Parameters:

clazz - The class that can be used to set and get values. This class will extend BaseHK2JAXBBean

location - The location of the file to parse

listener - A listener that must be called via the contract of Unmarshaller.Listener

Returns:

The root object with all fields filled in from the given document

Throws:

Exception

getPreGenerationRequirement

PreGenerationRequirement getPreGenerationRequirement()

This tells the system whether or not it needs to pregenerate all proxies prior to parsing a document or if the proxies can be generated lazily

Returns:

The value that indicates whether or not the proxies can be loaded lazily or must be pre-generated prior to parsing a document