Package org.apache.juneau.xml

Class XmlBeanPropertyMeta

java.lang.Object

org.apache.juneau.ExtendedMeta

org.apache.juneau.ExtendedBeanPropertyMeta

org.apache.juneau.xml.XmlBeanPropertyMeta

public class XmlBeanPropertyMeta
extends ExtendedBeanPropertyMeta

Metadata on bean properties specific to the XML serializers and parsers pulled from the @Xml annotation on the bean property.

See Also:

• XML Basics

Field Summary

Fields

Modifier and Type	Field	Description
static final XmlBeanPropertyMeta	DEFAULT	Default instance.

Constructor Summary

Constructors

Constructor	Description
XmlBeanPropertyMeta(BeanPropertyMeta bpm, XmlMetaProvider mp)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getChildName()	Returns the child element of this property from the Xml.childName() annotation on this bean property.
Namespace	getNamespace()	Returns the XML namespace associated with this bean property.
XmlFormat	getXmlFormat()	Returns the XML format of this property from the Xml.format() annotation on this bean property.

Methods inherited from class org.apache.juneau.ExtendedBeanPropertyMeta

getBeanPropertyMeta

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final XmlBeanPropertyMeta DEFAULT

Default instance.

Constructor Details

XmlBeanPropertyMeta

public XmlBeanPropertyMeta(BeanPropertyMeta bpm,
 XmlMetaProvider mp)

Constructor.

Parameters:

bpm - The metadata of the bean property of this additional metadata.

mp - XML metadata provider (for finding information about other artifacts).

Method Details

getNamespace

public Namespace getNamespace()

Returns the XML namespace associated with this bean property.

Namespace is determined in the following order of @Xml(prefix) annotation:

1. Bean property field.
2. Bean getter.
3. Bean setter.
4. Bean class.
5. Bean package.
6. Bean superclasses.
7. Bean superclass packages.
8. Bean interfaces.
9. Bean interface packages.

Returns:

The namespace associated with this bean property, or null if no namespace is associated with it.

getXmlFormat

public XmlFormat getXmlFormat()

Returns the XML format of this property from the Xml.format() annotation on this bean property.

Returns:

The XML format, or XmlFormat.DEFAULT if annotation not specified.

getChildName

public String getChildName()

Returns the child element of this property from the Xml.childName() annotation on this bean property.

Returns:

The child element, or null if annotation not specified.