Package org.apache.juneau.marshall.xml

Class XmlParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.ReaderParser

org.apache.juneau.marshall.xml.XmlParser

All Implemented Interfaces:

ArrayRecordReadable, RecordReadable, XmlMetaProvider

Direct Known Subclasses:

HtmlParser

public class XmlParser
extends ReaderParser
implements XmlMetaProvider, RecordReadable, ArrayRecordReadable

Parses text generated by the XmlSerializer class back into a POJO model.

Media types

Handles Content-Type types: text/xml

Description

See the XmlSerializer class for a description of Juneau-generated XML.

Example input (Map of name/age):

<object> <name>Alice</name> <age>30</age> </object>

Complex (nested object + array):

<object> <name>Alice</name> <age>30</age> <address> <street>123 Main St</street> <city>Boston</city> <state>MA</state> </address> <tags> <string>a</string> <string>b</string> <string>c</string> </tags> </object>

Notes:

• This class is thread safe and reusable.

See Also:

• XML

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlParser.Builder<SELF extends XmlParser.Builder<SELF>>	Builder class.
static final class	XmlParser.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() / copy() path.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final XmlParser	DEFAULT	Default parser, all default settings.
protected final Class<? extends XMLEventAllocator>	eventAllocator
protected final boolean	preserveRootElement
protected final Class<? extends XMLReporter>	reporter
protected final Class<? extends XMLResolver>	resolver
protected final boolean	validating

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
XmlParser(XmlParser.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
XmlParser.Builder<?>	copy()	Creates a builder from this context object.
static XmlParser.Builder<?>	create()	Creates a new builder for this object.
XmlParserSession.Builder<?>	createSession()	Create a session builder based on the properties defined on this context.
protected final XMLEventAllocator	getEventAllocator()	XML event allocator.
protected final XMLReporter	getReporter()	XML reporter.
protected final XMLResolver	getResolver()	XML resolver.
XmlParserSession	getSession()	Returns a session to use for this context.
XmlBeanMeta	getXmlBeanMeta(BeanMeta<?> bm)	Returns the language-specific metadata on the specified bean.
XmlBeanPropertyMeta	getXmlBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
XmlClassMeta	getXmlClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
boolean	isArrayRecordStreaming()	The XML array-record cursor is buffered/RecordAdapter-backed, not O(1) streaming.
protected final boolean	isPreserveRootElement()	Preserve root element during generalized parsing.
boolean	isRecordStreaming()	The XML record cursor is buffered/RecordAdapter-backed, not O(1) streaming.
protected final boolean	isValidating()	Enable validation.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
RecordReader	readArrayRecords(Object input)	Convenience delegator for the buffered array-element RecordReader using default session arguments.
RecordReader	readArrayRecords(Object input, String rootElementName)	Convenience delegator for the buffered array-element RecordReader with a caller-specified root element name, using default session arguments.
RecordReader	readRecords(Object input)	Convenience delegator for the whole-value RecordReader using default session arguments.

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParser

getStreamCharset, isReaderParser

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final XmlParser DEFAULT

Default parser, all default settings.

preserveRootElement

protected final boolean preserveRootElement

validating

protected final boolean validating

eventAllocator

protected final Class<? extends XMLEventAllocator> eventAllocator

reporter

protected final Class<? extends XMLReporter> reporter

resolver

protected final Class<? extends XMLResolver> resolver

Constructor Details

XmlParser

public XmlParser(XmlParser.Builder<?> builder)

Constructor.

Parameters:

builder - The property store containing all the settings for this object.

Method Details

create

public static XmlParser.Builder<?> create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public XmlParser.Builder<?> copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Parser

Returns:

A new Builder object.

createSession

public XmlParserSession.Builder<?> createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class ReaderParser

Returns:

A new session builder.

getSession

public XmlParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class ReaderParser

Returns:

A new session object.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Convenience delegator for the whole-value RecordReader using default session arguments. The real implementation lives on XmlParserSession.readRecords(Object).

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Convenience delegator for the buffered array-element RecordReader using default session arguments. The real implementation lives on XmlParserSession.readArrayRecords(Object).

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

Returns:

A buffered RecordReader.

Throws:

IOException - If a problem occurred reading the input.

readArrayRecords

public RecordReader readArrayRecords(Object input,
 String rootElementName)
                              throws IOException

Convenience delegator for the buffered array-element RecordReader with a caller-specified root element name, using default session arguments. The real implementation lives on XmlParserSession.readArrayRecords(Object, String).

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

rootElementName - The expected root element wrapping the array.

Returns:

A buffered RecordReader.

Throws:

IOException - If a problem occurred reading the input.

isRecordStreaming

public boolean isRecordStreaming()

The XML record cursor is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

Always false.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

The XML array-record cursor is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isArrayRecordStreaming in interface ArrayRecordReadable

Returns:

Always false.

getXmlBeanMeta

public XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified bean.

Specified by:

getXmlBeanMeta in interface XmlMetaProvider

Parameters:

bm - The bean to return the metadata on.

Returns:

The metadata.

getXmlBeanPropertyMeta

public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getXmlBeanPropertyMeta in interface XmlMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getXmlClassMeta

public XmlClassMeta getXmlClassMeta(ClassMeta<?> cm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getXmlClassMeta in interface XmlMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getEventAllocator

protected final XMLEventAllocator getEventAllocator()

XML event allocator.

Returns:

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

See Also:

• XmlParser.Builder.eventAllocator(Class)

getReporter

protected final XMLReporter getReporter()

XML reporter.

Returns:

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

See Also:

• XmlParser.Builder.reporter(Class)

getResolver

protected final XMLResolver getResolver()

XML resolver.

Returns:

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

See Also:

• XmlParser.Builder.resolver(Class)

isPreserveRootElement

protected final boolean isPreserveRootElement()

Preserve root element during generalized parsing.

Returns:

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

See Also:

• XmlParser.Builder.preserveRootElement()

isValidating

protected final boolean isValidating()

Enable validation.

Returns:

true if XML document will be validated.

See Also:

• XmlParser.Builder.validating()

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class ReaderParser

Returns:

The properties on this bean as a map for debugging.