@Documented @Target(value={TYPE,METHOD}) @Retention(value=RUNTIME) @Inherited @PropertyStoreApply(value=XmlConfigApply.class) public @interface XmlConfig
XmlSerializer
, XmlDocSerializer
, and XmlParser
.
Used primarily for specifying bean configuration properties on REST classes and methods.
Modifier and Type | Optional Element and Description |
---|---|
String |
addBeanTypes
Configuration property: Add
|
String |
addNamespaceUrisToRoot
Configuration property: Add namespace URLs to the root element.
|
String |
autoDetectNamespaces
Configuration property: Auto-detect namespace usage.
|
String |
defaultNamespace
Configuration property: Default namespace.
|
String |
enableNamespaces
Configuration property: Enable support for XML namespaces.
|
Class<? extends XMLEventAllocator> |
eventAllocator
Configuration property: XML event allocator.
|
String[] |
namespaces
Configuration property: Default namespaces.
|
String |
preserveRootElement
Configuration property: Preserve root element during generalized parsing.
|
int |
rank
Optional rank for this config.
|
Class<? extends XMLReporter> |
reporter
Configuration property: XML reporter.
|
Class<? extends XMLResolver> |
resolver
Configuration property: XML resolver.
|
String |
validating
Configuration property: Enable validation.
|
String |
xsNamespace
Configuration property: XMLSchema namespace.
|
public abstract int rank
Can be used to override default ordering and application of config annotations.
public abstract Class<? extends XMLEventAllocator> eventAllocator
Associates an XMLEventAllocator
with this parser.
public abstract String preserveRootElement
If ObjectMap
, the map will contain a single entry whose key
is the root element name.
public abstract Class<? extends XMLReporter> reporter
Associates an XMLReporter
with this parser.
public abstract Class<? extends XMLResolver> resolver
Associates an XMLResolver
with this parser.
public abstract String validating
If
See XMLInputFactory.IS_VALIDATING
for more info.
public abstract String addBeanTypes
If
When present, this value overrides the Serializer.SERIALIZER_addBeanTypes
setting and is
provided to customize the behavior of specific serializers in a SerializerGroup
.
public abstract String addNamespaceUrisToRoot
Use this setting to add xmlns:x
attributes to the root element for the default and all mapped namespaces.
XmlSerializer.XML_enableNamespaces
is not enabled.
public abstract String autoDetectNamespaces
Detect namespace usage before serialization.
Used in conjunction with XmlSerializer.XML_addNamespaceUrisToRoot
to reduce the list of namespace URLs appended to the
root element to only those that will be used in the resulting document.
If enabled, then the data structure will first be crawled looking for namespaces that will be encountered before the root element is serialized.
This setting is ignored if XmlSerializer.XML_enableNamespaces
is not enabled.
XmlSerializer.XML_namespaces
property.
public abstract String defaultNamespace
Specifies the default namespace URI for this document.
public abstract String enableNamespaces
If not enabled, XML output will not contain any namespaces regardless of any other settings.
public abstract String[] namespaces
The default list of namespaces associated with this serializer.
public abstract String xsNamespace
Specifies the namespace for the XmlSchemaSerializer
class.
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.