org.apache.juneau.xml

Class XmlParserSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.parser.ParserSession

org.apache.juneau.parser.ReaderParserSession

org.apache.juneau.xml.XmlParserSession

Direct Known Subclasses:

HtmlParserSession

public class XmlParserSession
extends ReaderParserSession

Session object that lives for the duration of a single use of XmlParser.

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused against multiple inputs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlParserSession(XmlParser ctx, ParserSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
protected String	decodeString(String s) Decodes and trims the specified string.
protected <T> T	doParse(ParserPipe pipe, ClassMeta<T> type) Workhorse method.
protected <E> Collection<E>	doParseIntoCollection(ParserPipe pipe, Collection<E> c, Type elementType) Implementation method.
protected <K,V> Map<K,V>	doParseIntoMap(ParserPipe pipe, Map<K,V> m, Type keyType, Type valueType) Implementation method.
protected String	getElementText(XmlReader r) Returns the text content of the current XML element.
protected XMLEventAllocator	getEventAllocator() Configuration property: XML event allocator.
protected XMLReporter	getReporter() Configuration property: XML reporter.
protected XMLResolver	getResolver() Configuration property: XML resolver.
protected XmlReader	getXmlReader(ParserPipe pipe) Wrap the specified reader in a STAX reader based on settings in this context.
protected boolean	isPreserveRootElement() Configuration property: Preserve root element during generalized parsing.
protected boolean	isValidating() Configuration property: Enable validation.
protected boolean	isWhitespaceElement(XmlReader r) Returns true if the current element is a whitespace element.
protected <T> T	parseAnything(ClassMeta<T> eType, String currAttr, XmlReader r, Object outer, boolean isRoot, BeanPropertyMeta pMeta) Workhorse method.
protected String	parseText(XmlReader r) Parses the current element as text.
protected String	parseWhitespaceElement(XmlReader r) Parses the current whitespace element.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

Methods inherited from class org.apache.juneau.parser.ReaderParserSession

createPipe, getFileCharset, getStreamCharset, isReaderParser

Methods inherited from class org.apache.juneau.parser.ParserSession

cast, convertAttrToType, getClassMeta, getDebugOutputLines, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getOuter, getPosition, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, mark, onUnknownProperty, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, trim, trim, unmark, unswap

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getBpi, getBpro, getBpwo, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getExamples, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlParserSession

protected XmlParserSession(XmlParser ctx,
                           ParserSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime session arguments.

Method Detail

getXmlReader

protected final XmlReader getXmlReader(ParserPipe pipe)
                                throws IOException,
                                       XMLStreamException

Wrap the specified reader in a STAX reader based on settings in this context.

Parameters:

pipe - The parser input.

Returns:

The new STAX reader.

Throws:

IOException - Thrown by underlying stream.

XMLStreamException - Unexpected XML processing error.

decodeString

protected final String decodeString(String s)

Decodes and trims the specified string.

Any '_x####_' sequences in the string will be decoded.

Parameters:

s - The string to be decoded.

Returns:

The decoded string.

getElementText

protected String getElementText(XmlReader r)
                         throws XMLStreamException,
                                IOException,
                                ParseException

Returns the text content of the current XML element.

Any '_x####_' sequences in the string will be decoded.

Leading and trailing whitespace (unencoded) will be trimmed from the result.

Parameters:

r - The reader to read the element text from.

Returns:

The decoded text. null if the text consists of the sequence '_x0000_'.

Throws:

XMLStreamException - Thrown by underlying reader.

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

parseText

protected String parseText(XmlReader r)
                    throws IOException,
                           XMLStreamException,
                           ParseException

Parses the current element as text.

Parameters:

r - The input reader.

Returns:

The parsed text.

Throws:

XMLStreamException - Thrown by underlying reader.

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

isWhitespaceElement

protected boolean isWhitespaceElement(XmlReader r)

Returns true if the current element is a whitespace element.

For the XML parser, this always returns false. However, the HTML parser defines various whitespace elements such as "br" and "sp".

Parameters:

r - The XML stream reader to read the current event from.

Returns:

true if the current element is a whitespace element.

parseWhitespaceElement

protected String parseWhitespaceElement(XmlReader r)
                                 throws IOException,
                                        XMLStreamException,
                                        ParseException

Parses the current whitespace element.

For the XML parser, this always returns null since there is no concept of a whitespace element. However, the HTML parser defines various whitespace elements such as "br" and "sp".

Parameters:

r - The XML stream reader to read the current event from.

Returns:

The whitespace character or characters.

Throws:

XMLStreamException - Thrown by underlying reader.

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

doParse

protected <T> T doParse(ParserPipe pipe,
                        ClassMeta<T> type)
                 throws IOException,
                        ParseException,
                        ExecutableException

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method.

Specified by:

doParse in class ParserSession

Type Parameters:

T - The class type of the object to create.

Parameters:

pipe - Where to get the input from.

type - The class type of the object to create. If null or Object.class, object type is based on what's being parsed. For example, when parsing JSON text, it may return a String, Number, ObjectMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.

doParseIntoMap

protected <K,V> Map<K,V> doParseIntoMap(ParserPipe pipe,
                                        Map<K,V> m,
                                        Type keyType,
                                        Type valueType)
                                 throws Exception

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doParseIntoMap in class ParserSession

Parameters:

pipe - The parser input.

m - The map being loaded.

keyType - The class type of the keys, or null to default to String.class.

valueType - The class type of the values, or null to default to whatever is being parsed.

Returns:

The same map that was passed in to allow this method to be chained.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

doParseIntoCollection

protected <E> Collection<E> doParseIntoCollection(ParserPipe pipe,
                                                  Collection<E> c,
                                                  Type elementType)
                                           throws Exception

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doParseIntoCollection in class ParserSession

Parameters:

pipe - The parser input.

c - The collection being loaded.

elementType - The class type of the elements, or null to default to whatever is being parsed.

Returns:

The same collection that was passed in to allow this method to be chained.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

parseAnything

protected <T> T parseAnything(ClassMeta<T> eType,
                              String currAttr,
                              XmlReader r,
                              Object outer,
                              boolean isRoot,
                              BeanPropertyMeta pMeta)
                       throws IOException,
                              ParseException,
                              ExecutableException,
                              XMLStreamException

Workhorse method.

Type Parameters:

T - The expected type of object.

Parameters:

eType - The expected type of object.

currAttr - The current bean property name.

r - The reader.

outer - The outer object.

isRoot - If true, then we're serializing a root element in the document.

pMeta - The bean property metadata.

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.

XMLStreamException - Malformed XML encountered.

getEventAllocator

protected final XMLEventAllocator getEventAllocator()

Configuration property: XML event allocator.

Returns:

The XMLEventAllocator associated with this parser, or null if there isn't one.

See Also:

XmlParser.XML_eventAllocator

isPreserveRootElement

protected final boolean isPreserveRootElement()

Configuration property: Preserve root element during generalized parsing.

Returns:

true if when parsing into a generic ObjectMap, the map will contain a single entry whose key is the root element name.

See Also:

XmlParser.XML_preserveRootElement

getReporter

protected final XMLReporter getReporter()

Configuration property: XML reporter.

Returns:

The XMLReporter associated with this parser, or null if there isn't one.

See Also:

XmlParser.XML_reporter

getResolver

protected final XMLResolver getResolver()

Configuration property: XML resolver.

Returns:

The XMLResolver associated with this parser, or null if there isn't one.

See Also:

XmlParser.XML_resolver

isValidating

protected final boolean isValidating()

Configuration property: Enable validation.

Returns:

true if XML document will be validated.

See Also:

XmlParser.XML_validating

toMap

public ObjectMap toMap()

Description copied from class: Session

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class ReaderParserSession

Returns:

A new map containing the properties defined on this context.