Package org.apache.juneau.xml

Class XmlParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.xml.XmlParser

All Implemented Interfaces:

XmlMetaProvider

Direct Known Subclasses:

HtmlParser

public class XmlParser
extends ReaderParser
implements XmlMetaProvider

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.

Notes:

• This class is thread safe and reusable.

See Also:

• XML Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlParser.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.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.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, strict, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.BeanContextable

beanContext

Fields inherited from class org.apache.juneau.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.
protected final boolean	isPreserveRootElement()	Preserve root element during generalized parsing.
protected final boolean	isValidating()	Enable validation.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.

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

getFileCharset, getStreamCharset, isReaderParser

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

canHandle, createParserBuilder, doParse, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.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.

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.