org.glassfish.hk2.xml.api

Interface XmlService

All Known Implementing Classes:

XmlServiceImpl

@Contract
public interface XmlService

Author:

jwells

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	createBean(Class<T> beanInterface) This creates an instance of the given bean type of with no fields of the bean filled in.
<T> XmlRootHandle<T>	createEmptyHandle(Class<T> jaxbAnnotationInterface) This creates an empty handle (root will initially be null) corresponding to the given interface class
<T> XmlRootHandle<T>	createEmptyHandle(Class<T> jaxbAnnotationInterface, boolean advertiseInRegistry, boolean advertiseInHub) This creates an empty handle (root will initially be null) corresponding to the given interface class
<T> XmlRootHandle<T>	unmarshall(URI uri, Class<T> jaxbAnnotatedInterface) Unmarshalls the given URI using the jaxb annotated interface.
<T> XmlRootHandle<T>	unmarshall(URI uri, Class<T> jaxbAnnotatedInterface, boolean advertiseInRegistry, boolean advertiseInHub) Unmarshalls the given URI using the jaxb annotated interface.
<T> XmlRootHandle<T>	unmarshall(XMLStreamReader reader, Class<T> jaxbAnnotatedInterface, boolean advertiseInRegistry, boolean advertiseInHub) Unmarshalls an XML stream using the jaxb annotated interface.

Method Detail

unmarshall

<T> XmlRootHandle<T> unmarshall(URI uri,
                              Class<T> jaxbAnnotatedInterface)

Unmarshalls the given URI using the jaxb annotated interface. The resulting JavaBean tree will be advertised in the ServiceLocator and in the Hub. Will use the registered implementation of XmlServiceParser to parse the file.

Parameters:

uri - The non-null URI whereby to find the xml corresponding to the class

jaxbAnnotatedClassOrInterface - The non-null class corresonding to the Xml to be parsed

Returns:

A non-null handle that can be used to get the unmarshalled data or perform other tasks

unmarshall

<T> XmlRootHandle<T> unmarshall(URI uri,
                              Class<T> jaxbAnnotatedInterface,
                              boolean advertiseInRegistry,
                              boolean advertiseInHub)

Unmarshalls the given URI using the jaxb annotated interface. Will use the registered implementation of XmlServiceParser to parse the file.

Parameters:

uri - The non-null URI whereby to find the xml corresponding to the class

jaxbAnnotatedClassOrInterface - The non-null interface corresponding to the Xml to be parsed

advertiseInRegistry - if true the entire tree of parsed xml will be added to the ServiceLocator

advertiseInHub - if true the entire tree of parsed xml will be added to the HK2 configuration Hub (as bean-like maps)

Returns:

A non-null handle that can be used to get the unmarshalled data or perform other tasks

unmarshall

<T> XmlRootHandle<T> unmarshall(XMLStreamReader reader,
                              Class<T> jaxbAnnotatedInterface,
                              boolean advertiseInRegistry,
                              boolean advertiseInHub)

Unmarshalls an XML stream using the jaxb annotated interface. Will use a built-in algorithm to read the stream

Parameters:

reader - The non-null XMLStreamReader representing the XML to be read

jaxbAnnotatedClassOrInterface - The non-null interface corresponding to the Xml to be parsed

advertiseInRegistry - if true the entire tree of parsed xml will be added to the ServiceLocator

advertiseInHub - if true the entire tree of parsed xml will be added to the HK2 configuration Hub (as bean-like maps)

Returns:

A non-null handle that can be used to get the unmarshalled data or perform other tasks

createEmptyHandle

<T> XmlRootHandle<T> createEmptyHandle(Class<T> jaxbAnnotationInterface,
                                     boolean advertiseInRegistry,
                                     boolean advertiseInHub)

This creates an empty handle (root will initially be null) corresponding to the given interface class

Parameters:

jaxbAnnotationInterface - The non-null interface class corresponding to the XML to be parsed

advertiseInRegistry - if true the entire tree of parsed xml will be added to the ServiceLocator

advertiseInHub - if true the entire tree of parsed xml will be added to the HK2 configuration Hub (as bean-like maps)

Returns:

A non-null handle that can be used to create a new root bean, but which is not initially tied to any backing file or other input stream

createEmptyHandle

<T> XmlRootHandle<T> createEmptyHandle(Class<T> jaxbAnnotationInterface)

This creates an empty handle (root will initially be null) corresponding to the given interface class

Parameters:

jaxbAnnotationInterface - The non-null interface class corresponding to the XML to be parsed

Returns:

A non-null handle that can be used to create a new root bean, but which is not initially tied to any backing file or other input stream

createBean

<T> T createBean(Class<T> beanInterface)

This creates an instance of the given bean type of with no fields of the bean filled in. Objects created with this API can be used in the adder methods of the beans, and will not be validated (but all setters and getters and lookups will work properly)

Returns:

An instance of the bean with no properties set