Package org.apache.juneau.xml.annotation

Annotation Interface XmlConfig

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@ContextApply({SerializerApply.class,ParserApply.class})
public @interface XmlConfig

Annotation for specifying config properties defined in XmlSerializer, XmlDocSerializer, and XmlParser.

Used primarily for specifying bean configuration properties on REST classes and methods.

See Also:

• XML Basics

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	addBeanTypes	Add "_type" properties when needed.
String	addNamespaceUrisToRoot	Add namespace URLs to the root element.
String	defaultNamespace	Default namespace.
String	disableAutoDetectNamespaces	Don't auto-detect namespace usage.
String	enableNamespaces	Enable support for XML namespaces.
Class<? extends XMLEventAllocator>	eventAllocator	XML event allocator.
String[]	namespaces	Default namespaces.
String	preserveRootElement	Preserve root element during generalized parsing.
int	rank	Optional rank for this config.
Class<? extends XMLReporter>	reporter	XML reporter.
Class<? extends XMLResolver>	resolver	XML resolver.
String	validating	Enable validation.

Element Details

addBeanTypes

String addBeanTypes

Add "_type" properties when needed.

If "true", then "_type" properties will be added to beans if their type cannot be inferred through reflection.

When present, this value overrides the Serializer.Builder.addBeanTypes() setting and is provided to customize the behavior of specific serializers in a SerializerSet.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlSerializer.Builder.addBeanTypesXml()

Returns:

The annotation value.

Default:

""

addNamespaceUrisToRoot

String addNamespaceUrisToRoot

Add namespace URLs to the root element.

Use this setting to add xmlns:x attributes to the root element for the default and all mapped namespaces.

• "true"
• "false" (default)

Notes:

• This setting is ignored if XmlSerializer.Builder.enableNamespaces() is not enabled.
• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlSerializer.Builder.addNamespaceUrisToRoot()
• Namespaces

Returns:

The annotation value.

Default:

""

defaultNamespace

String defaultNamespace

Default namespace.

Specifies the default namespace URI for this document.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlSerializer.Builder.defaultNamespace(Namespace)
• Namespaces

Returns:

The annotation value.

Default:

""

disableAutoDetectNamespaces

String disableAutoDetectNamespaces

Don't auto-detect namespace usage.

Don't detect namespace usage before serialization.

Used in conjunction with XmlSerializer.Builder.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 disabled, 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.Builder.enableNamespaces() is not enabled.

• "true"
• "false" (default)

Notes:

• Auto-detection of namespaces can be costly performance-wise.
  In high-performance environments, it's recommended that namespace detection be disabled, and that namespaces be manually defined through the XmlSerializer.Builder.namespaces(Namespace...) property.
• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlSerializer.Builder.disableAutoDetectNamespaces()
• Namespaces

Returns:

The annotation value.

Default:

""

enableNamespaces

String enableNamespaces

Enable support for XML namespaces.

If not enabled, XML output will not contain any namespaces regardless of any other settings.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlSerializer.Builder.enableNamespaces()
• Namespaces

Returns:

The annotation value.

Default:

""

eventAllocator

Class<? extends XMLEventAllocator> eventAllocator

XML event allocator.

Associates an XMLEventAllocator with this parser.

See Also:

• XmlParser.Builder.eventAllocator(Class)

Returns:

The annotation value.

Default:

org.apache.juneau.xml.XmlEventAllocator.Void.class

namespaces

String[] namespaces

Default namespaces.

The default list of namespaces associated with this serializer.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlSerializer.Builder.namespaces(Namespace...)
• Namespaces

Returns:

The annotation value.

Default:

{}

preserveRootElement

String preserveRootElement

Preserve root element during generalized parsing.

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

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlParser.Builder.preserveRootElement()

Returns:

The annotation value.

Default:

""

rank

int rank

Optional rank for this config.

Can be used to override default ordering and application of config annotations.

Returns:

The annotation value.

Default:

0

reporter

Class<? extends XMLReporter> reporter

XML reporter.

Associates an XMLReporter with this parser.

Notes:

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

See Also:

• XmlParser.Builder.reporter(Class)

Returns:

The annotation value.

Default:

org.apache.juneau.xml.XmlReporter.Void.class

resolver

Class<? extends XMLResolver> resolver

XML resolver.

Associates an XMLResolver with this parser.

See Also:

• XmlParser.Builder.resolver(Class)

Returns:

The annotation value.

Default:

org.apache.juneau.xml.XmlResolver.Void.class

validating

String validating

Enable validation.

If "true", XML document will be validated.

See XMLInputFactory.IS_VALIDATING for more info.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• XmlParser.Builder.validating()

Returns:

The annotation value.

Default:

""