@ConfigurableContext public class XmlParser extends ReaderParser implements XmlMetaProvider, XmlCommon
XmlSerializer
class back into a POJO model.
XmlSerializer
class for a description of Juneau-generated XML.Parser.Null
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.
|
RPARSER_fileCharset, RPARSER_streamCharset
PARSER_autoCloseStreams, PARSER_debugOutputLines, PARSER_listener, PARSER_strict, PARSER_trimStrings, PARSER_unbuffered
BEAN_annotations, 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_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreTransientFields, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, 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_swaps, BEAN_swaps_add, BEAN_swaps_remove, BEAN_typePropertyName, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED
CONTEXT_debug, CONTEXT_locale, CONTEXT_mediaType, CONTEXT_timeZone
Constructor and Description |
---|
XmlParser(PropertyStore ps)
Constructor.
|
XmlParser(PropertyStore ps,
String... consumes)
Constructor.
|
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()
XML event allocator.
|
protected XMLReporter |
getReporter()
XML reporter.
|
protected XMLResolver |
getResolver()
XML resolver.
|
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 boolean |
isPreserveRootElement()
Preserve root element during generalized parsing.
|
protected boolean |
isValidating()
Enable validation.
|
OMap |
toMap()
Returns the properties defined on this bean context as a simple map for debugging purposes.
|
getFileCharset, getStreamCharset, isReaderParser
canHandle, createDefaultSessionArgs, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap
_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanToStringSerializer, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getDeclaredAnnotations, getDeclaredAnnotations, getExamples, getImplClassConstructor, getImplClasses, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastDeclaredAnnotation, getLastDeclaredAnnotation, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreTransientFields, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string
equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getDefaultLocale, getDefaultMediaType, getDefaultTimeZone, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, isDebug, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAnnotations, getAnnotations, getAnnotations, getAnnotations, getDeclaredAnnotations
public static final String XML_eventAllocator
XML_eventAllocator
Class<XMLEventAllocator
>
Associates an XMLEventAllocator
with this parser.
public static final String XML_preserveRootElement
XML_preserveRootElement
If OMap
, the map will contain a single entry whose key
is the root element name.
public static final String XML_reporter
XML_reporter
Class<XMLReporter
>
Associates an XMLReporter
with this parser.
public static final String XML_resolver
XML_resolver
Class<XMLResolver
>
Associates an XMLResolver
with this parser.
public static final String XML_validating
XML_validating
If
See XMLInputFactory.IS_VALIDATING
for more info.
public XmlParser(PropertyStore ps)
ps
- The property store containing all the settings for this object.public XmlParser(PropertyStore ps, String... consumes)
ps
- The property store containing all the settings for this object.consumes
- The list of media types that this parser consumes (e.g. public XmlParserBuilder builder()
Context
Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.
public static XmlParserBuilder create()
XmlParserBuilder
object.
This is equivalent to simply calling
.
Note that this method creates a builder initialized to all default settings, whereas builder()
copies
the settings of the object called on.
XmlParserBuilder
object.public XmlParserSession createSession()
BeanContext
Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.
createSession
in class Parser
public XmlParserSession createSession(ParserSessionArgs args)
Parser
It's up to implementers to decide what the session object looks like, although typically it's going to be a
subclass of ParserSession
.
createSession
in class Parser
args
- Runtime arguments.public XmlClassMeta getXmlClassMeta(ClassMeta<?> cm)
XmlMetaProvider
getXmlClassMeta
in interface XmlMetaProvider
cm
- The class to return the metadata on.public XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm)
XmlMetaProvider
getXmlBeanMeta
in interface XmlMetaProvider
bm
- The bean to return the metadata on.public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm)
XmlMetaProvider
getXmlBeanPropertyMeta
in interface XmlMetaProvider
bpm
- The bean property to return the metadata on.protected final XMLEventAllocator getEventAllocator()
XMLEventAllocator
associated with this parser, or XML_eventAllocator
protected final boolean isPreserveRootElement()
OMap
, the map will contain a single entry whose key
is the root element name.XML_preserveRootElement
protected final XMLReporter getReporter()
XMLReporter
associated with this parser, or XML_reporter
protected final XMLResolver getResolver()
XMLResolver
associated with this parser, or XML_resolver
protected final boolean isValidating()
XML_validating
public OMap toMap()
Context
toMap
in class ReaderParser
Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.