org.apache.juneau.xml

Class XmlParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.xml.XmlParser

Direct Known Subclasses:

HtmlParser

@ConfigurableContext
public class XmlParser
extends ReaderParser

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.

Field Summary

Fields

Modifier and Type	Field and Description
static XmlParser	DEFAULT Default parser, all default settings.
static String	XML_eventAllocator Configuration property: XML event allocator.
static String	XML_preserveRootElement Configuration property: Preserve root element during generalized parsing.
static String	XML_reporter Configuration property: XML reporter.
static String	XML_resolver Configuration property: XML resolver.
static String	XML_validating Configuration property: Enable validation.

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

RPARSER_fileCharset, RPARSER_streamCharset

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

PARSER_autoCloseStreams, PARSER_debugOutputLines, PARSER_listener, PARSER_strict, PARSER_trimStrings, PARSER_unbuffered

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
XmlParser(PropertyStore ps) Constructor.
XmlParser(PropertyStore ps, String... consumes) Constructor.

Method Summary

Modifier and Type	Method and Description
XmlParserBuilder	builder() Creates a builder from this context object.
static XmlParserBuilder	create() Instantiates a new clean-slate XmlParserBuilder object.
XmlParserSession	createSession() Create a new bean session based on the properties defined on this context.
XmlParserSession	createSession(ParserSessionArgs args) Create the session object that will be passed in to the parse method.
protected XMLEventAllocator	getEventAllocator() Configuration property: XML event allocator.
protected XMLReporter	getReporter() Configuration property: XML reporter.
protected XMLResolver	getResolver() Configuration property: XML resolver.
protected boolean	isPreserveRootElement() Configuration property: Preserve root element during generalized parsing.
protected boolean	isValidating() Configuration property: Enable validation.
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.ReaderParser

getFileCharset, getStreamCharset, isReaderParser

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

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

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getImplClassConstructor, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XML_eventAllocator

public static final String XML_eventAllocator

Configuration property: XML event allocator.

Property:

• Name: "XmlParser.eventAllocator.c"
• Data type: Class<? extends XMLEventAllocator>
• Default: null
• Session property: false
• Methods:
  • XmlParserBuilder.eventAllocator(XMLEventAllocator)

Description:

Associates an XMLEventAllocator with this parser.

See Also:

Constant Field Values

XML_preserveRootElement

public static final String XML_preserveRootElement

Configuration property: Preserve root element during generalized parsing.

Property:

• Name: "XmlParser.preserveRootElement.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • XmlParserBuilder.preserveRootElement(boolean)
  • XmlParserBuilder.preserveRootElement()

Description:

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

Example:

// Parser with preserve-root-element. ReaderParser p1 = XmlParser .create() .preserveRootElement(true) .build(); // Parser without preserve-root-element (the default behavior). ReaderParser p2 = XmlParser .create() .preserveRootElement(false) .build(); String xml = "<root><a>foobar</a></root>"; // Produces: "{ root: { a:'foobar' }}" ObjectMap m1 = p1.parse(xml, ObjectMap.class); // Produces: "{ a:'foobar' }" ObjectMap m2 = p2.parse(xml, ObjectMap.class);

See Also:

Constant Field Values

XML_reporter

public static final String XML_reporter

Configuration property: XML reporter.

Property:

• Name: "XmlParser.reporter.c"
• Data type: Class<? extends XMLReporter>
• Default: null
• Session property: false
• Methods:
  • XmlParserBuilder.reporter(XMLReporter)

Description:

Associates an XMLReporter with this parser.

• Reporters are not copied to new parsers during a clone.

See Also:

Constant Field Values

XML_resolver

public static final String XML_resolver

Configuration property: XML resolver.

Property:

• Name: "XmlParser.resolver.c"
• Data type: Class<? extends XMLResolver>
• Default: null
• Session property: false
• Methods:
  • XmlParserBuilder.resolver(XMLResolver)

Description:

Associates an XMLResolver with this parser.

See Also:

Constant Field Values

XML_validating

public static final String XML_validating

Configuration property: Enable validation.

Property:

• Name: "XmlParser.validating.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • XmlParserBuilder.validating(boolean)
  • XmlParserBuilder.validating()

Description:

If true, XML document will be validated.

See XMLInputFactory.IS_VALIDATING for more info.

See Also:

Constant Field Values

DEFAULT

public static final XmlParser DEFAULT

Default parser, all default settings.

Constructor Detail

XmlParser

public XmlParser(PropertyStore ps)

Constructor.

Parameters:

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

XmlParser

public XmlParser(PropertyStore ps,
                 String... consumes)

Constructor.

Parameters:

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

consumes - The list of media types that this parser consumes (e.g. "application/json", "*/json").

Method Detail

builder

public XmlParserBuilder builder()

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:

builder in class Parser

Returns:

A new ContextBuilder object.

create

public static XmlParserBuilder create()

Instantiates a new clean-slate XmlParserBuilder object.

This is equivalent to simply calling new XmlParserBuilder().

Note that this method creates a builder initialized to all default settings, whereas builder() copies the settings of the object called on.

Returns:

A new XmlParserBuilder object.

createSession

public XmlParserSession createSession()

Description copied from class: BeanContext

Create a new bean session based on the properties defined on this context.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class Parser

Returns:

A new session object.

createSession

public XmlParserSession createSession(ParserSessionArgs args)

Description copied from class: Parser

Create the session object that will be passed in to the parse method.

It's up to implementers to decide what the session object looks like, although typically it's going to be a subclass of ParserSession.

Specified by:

createSession in class Parser

Parameters:

args - Runtime arguments.

Returns:

The new session.

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:

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:

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:

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:

XML_resolver

isValidating

protected final boolean isValidating()

Configuration property: Enable validation.

Returns:

true if XML document will be validated.

See Also:

XML_validating

toMap

public ObjectMap toMap()

Description copied from class: Context

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

Overrides:

toMap in class ReaderParser

Returns:

A new map containing the properties defined on this context.