com.sun.jersey.json.impl

Class DefaultJaxbXmlDocumentStructure

java.lang.Object

com.sun.jersey.json.impl.DefaultJaxbXmlDocumentStructure

All Implemented Interfaces:

JaxbXmlDocumentStructure

Direct Known Subclasses:

JaxbJdkXmlStructure, JaxbRiXmlStructure, MoxyXmlStructure

public abstract class DefaultJaxbXmlDocumentStructure
extends Object
implements JaxbXmlDocumentStructure

Default implementation of JaxbXmlDocumentStructure.

Author:

Michal Gajdos (michal.gajdos at oracle.com)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultJaxbXmlDocumentStructure(JAXBContext jaxbContext, Class<?> expectedType, boolean isReader)

Method Summary

Modifier and Type	Method and Description
boolean	canHandleAttributes() Returns true if the implementation is capable of handling and providing information about attributes (#getExpectedAttributes and #getExpectedAttributesMap return valid results), false otherwise.
void	endElement(QName name) Notifies this structure provider that an end element event has been fired and that the parent element of the one with the given name should be processed.
Type	getEntityType(QName entity, boolean isAttribute) Returns the Type of entity (element, attribute) with the given name.
Collection<QName>	getExpectedAttributes() Returns a collection of expected attributes of currently processed element.
Map<String,QName>	getExpectedAttributesMap() Returns a map of expected attributes of currently processed element where key is represented by the local name of the attribute and value is it's qualified name.
Collection<QName>	getExpectedElements() Returns a collection of expected sub-elements of currently processed element.
Map<String,QName>	getExpectedElementsMap() Returns a map of expected sub-elements of currently processed element where key is represented by the local name of the sub-element and value is it's qualified name.
Type	getIndividualType() Returns the Type of individuals stored in an array/list.
static JaxbXmlDocumentStructure	getXmlDocumentStructure(JAXBContext jaxbContext, Class<?> expectedType, boolean isReader) Creates an JaxbXmlDocumentStructure for XMLStreamReader or XMLStreamWriter based on a given JAXBContext.
void	handleAttribute(QName attributeName, String value) Notifies this structure provider about an attribute event with the given name has been fired and that this attribute will be processed.
boolean	isArrayCollection() Returns true if the currently processed element should represent an JSON array element.
boolean	isSameArrayCollection() Returns true if the currently processed element belongs to the same JSON array as the previous element.
protected Map<String,QName>	qnameCollectionToMap(Collection<QName> collection, boolean elementCollection) Transforms a collection of qualified names into a map.
void	startElement(QName name) Notifies this structure provider that a start element event with the given name has been fired and that this element will be processed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.jersey.json.impl.JaxbXmlDocumentStructure

hasSubElements

Constructor Detail

DefaultJaxbXmlDocumentStructure

protected DefaultJaxbXmlDocumentStructure(JAXBContext jaxbContext,
                                          Class<?> expectedType,
                                          boolean isReader)

Method Detail

getXmlDocumentStructure

public static JaxbXmlDocumentStructure getXmlDocumentStructure(JAXBContext jaxbContext,
                                                               Class<?> expectedType,
                                                               boolean isReader)
                                                        throws IllegalStateException

Creates an JaxbXmlDocumentStructure for XMLStreamReader or XMLStreamWriter based on a given JAXBContext.

Parameters:

jaxbContext - JAXBContext to create this JaxbXmlDocumentStructure for.

expectedType - expected type that is going to be (un)marshalled.

isReader - true if the instance should be created for a reader, false if the instance is intended for a writer.

Returns:

an JaxbXmlDocumentStructure instance for the JAXBContext

Throws:

IllegalStateException - if the given JAXBContext is an unsupported implementation.

getExpectedElements

public Collection<QName> getExpectedElements()

Description copied from interface: JaxbXmlDocumentStructure

Returns a collection of expected sub-elements of currently processed element.

Specified by:

getExpectedElements in interface JaxbXmlDocumentStructure

Returns:

a collection of expected sub-elements.

getExpectedAttributes

public Collection<QName> getExpectedAttributes()

Description copied from interface: JaxbXmlDocumentStructure

Returns a collection of expected attributes of currently processed element.

Specified by:

getExpectedAttributes in interface JaxbXmlDocumentStructure

Returns:

a collection of expected attributes.

getExpectedElementsMap

public Map<String,QName> getExpectedElementsMap()

Description copied from interface: JaxbXmlDocumentStructure

Returns a map of expected sub-elements of currently processed element where key is represented by the local name of the sub-element and value is it's qualified name.

Specified by:

getExpectedElementsMap in interface JaxbXmlDocumentStructure

Returns:

a map of expected sub-elements.

getExpectedAttributesMap

public Map<String,QName> getExpectedAttributesMap()

Description copied from interface: JaxbXmlDocumentStructure

Returns a map of expected attributes of currently processed element where key is represented by the local name of the attribute and value is it's qualified name.

Specified by:

getExpectedAttributesMap in interface JaxbXmlDocumentStructure

Returns:

a map of expected attributes.

startElement

public void startElement(QName name)

Description copied from interface: JaxbXmlDocumentStructure

Notifies this structure provider that a start element event with the given name has been fired and that this element will be processed.

Specified by:

startElement in interface JaxbXmlDocumentStructure

Parameters:

name - name of the element that will be processed.

endElement

public void endElement(QName name)

Description copied from interface: JaxbXmlDocumentStructure

Notifies this structure provider that an end element event has been fired and that the parent element of the one with the given name should be processed.

Specified by:

endElement in interface JaxbXmlDocumentStructure

Parameters:

name - name of the ending element.

canHandleAttributes

public boolean canHandleAttributes()

Description copied from interface: JaxbXmlDocumentStructure

Returns true if the implementation is capable of handling and providing information about attributes (#getExpectedAttributes and #getExpectedAttributesMap return valid results), false otherwise.

Specified by:

canHandleAttributes in interface JaxbXmlDocumentStructure

Returns:

true if expected attributes can be obtained, false otherwise.

getEntityType

public Type getEntityType(QName entity,
                          boolean isAttribute)

Description copied from interface: JaxbXmlDocumentStructure

Returns the Type of entity (element, attribute) with the given name. The given entity name is expected to be either name of the current element or name of it's direct child.

Specified by:

getEntityType in interface JaxbXmlDocumentStructure

Parameters:

entity - name of the entity to retrieve the Type for.

isAttribute - flag whether the requested entity is an attribute or not.

Returns:

type of the entity or null if the entity cannot be retrieved from the structure.

getIndividualType

public Type getIndividualType()

Description copied from interface: JaxbXmlDocumentStructure

Returns the Type of individuals stored in an array/list.

Note: This method should be called only if an invocation of JaxbXmlDocumentStructure.getEntityType(javax.xml.namespace.QName, boolean) returns a collection/array type.

Specified by:

getIndividualType in interface JaxbXmlDocumentStructure

Returns:

type of the entity or null if the entity cannot be retrieved from the structure.

handleAttribute

public void handleAttribute(QName attributeName,
                            String value)

Description copied from interface: JaxbXmlDocumentStructure

Notifies this structure provider about an attribute event with the given name has been fired and that this attribute will be processed.

Specified by:

handleAttribute in interface JaxbXmlDocumentStructure

Parameters:

attributeName - name of the attribute that will be processed.

value - value of the attribute.

isArrayCollection

public boolean isArrayCollection()

Description copied from interface: JaxbXmlDocumentStructure

Returns true if the currently processed element should represent an JSON array element.

Specified by:

isArrayCollection in interface JaxbXmlDocumentStructure

Returns:

true if the element is an JSON array element, false otherwise.

isSameArrayCollection

public boolean isSameArrayCollection()

Description copied from interface: JaxbXmlDocumentStructure

Returns true if the currently processed element belongs to the same JSON array as the previous element.

Specified by:

isSameArrayCollection in interface JaxbXmlDocumentStructure

Returns:

true if the element is an JSON array belongs to the same JSON array as the previous element, false otherwise.

qnameCollectionToMap

protected Map<String,QName> qnameCollectionToMap(Collection<QName> collection,
                                                 boolean elementCollection)

Transforms a collection of qualified names into a map. Keys of this map are represented by local names and values of this map are the qualified names themselves.

Parameters:

collection - collection to be transformed.

elementCollection - flag whether the collection represents a collection of qualified names of elements.

Returns:

map of qualified names.