Package org.apache.juneau.marshall.xml

Class XmlBeanMeta

java.lang.Object

org.apache.juneau.marshall.ExtendedMeta

org.apache.juneau.marshall.ExtendedBeanMeta

org.apache.juneau.marshall.xml.XmlBeanMeta

public class XmlBeanMeta
extends ExtendedBeanMeta

Metadata on beans specific to the XML serializers and parsers pulled from the @Xml annotation on the class.

See Also:

• XML

Constructor Summary

Constructors

Constructor	Description
XmlBeanMeta(BeanMeta<?> beanMeta, XmlMetaProvider mp)	Constructor.

Method Summary

Modifier and Type	Method	Description
Map<String,BeanPropertyMeta>	getAttrProperties()	The list of properties that should be rendered as XML attributes.
protected Set<String>	getAttrPropertyNames()	The list of names of properties that should be rendered as XML attributes.
protected BeanPropertyMeta	getAttrsProperty()	The property that returns a map of XML attributes as key/value pairs.
protected String	getAttrsPropertyName()	The name of the property that returns a map of XML attributes as key/value pairs.
protected Map<String,BeanPropertyMeta>	getCollapsedProperties()	The list of properties that should be rendered as collapsed child elements.
protected Set<String>	getCollapsedPropertyNames()	The list of names of properties that should be rendered as collapsed child elements.
XmlFormat	getContentFormat()	Returns the format of the inner XML content of this bean.
BeanPropertyMeta	getContentProperty()	The property that represents the inner XML content of this bean.
protected String	getContentPropertyName()	The name of the property that represents the inner XML content of this bean.
protected Map<String,BeanPropertyMeta>	getElementProperties()	The list of properties that should be rendered as child elements.
protected Set<String>	getElementPropertyNames()	The list of names of properties that should be rendered as child elements.
protected BeanPropertyMeta	getPropertyMeta(String fieldName)	Returns bean property meta with the specified name.

Methods inherited from class org.apache.juneau.marshall.ExtendedBeanMeta

getBeanMeta

Methods inherited from class java.lang.Object

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

Constructor Details

XmlBeanMeta

public XmlBeanMeta(BeanMeta<?> beanMeta,
 XmlMetaProvider mp)

Constructor.

Parameters:

beanMeta - The metadata on the bean that this metadata applies to.
Must not be null.

mp - XML metadata provider (for finding information about other artifacts).
Must not be null.

Method Details

getAttrProperties

public Map<String,BeanPropertyMeta> getAttrProperties()

The list of properties that should be rendered as XML attributes.

Returns:

Map of property names to property metadata.

getContentFormat

public XmlFormat getContentFormat()

Returns the format of the inner XML content of this bean.

Can be one of the following:

• XmlFormat.FREEFORM
• XmlFormat.MIXED
• XmlFormat.MIXED_PWS
• XmlFormat.TEXT
• XmlFormat.TEXT_PWS
• XmlFormat.XMLTEXT
• XmlFormat.RAWTEXT
• XmlFormat.VOID
• null

Returns:

The format of the inner XML content of this bean.

getContentProperty

public BeanPropertyMeta getContentProperty()

The property that represents the inner XML content of this bean.

Returns:

The bean property metadata, or null if there is no such method.

getAttrPropertyNames

protected Set<String> getAttrPropertyNames()

The list of names of properties that should be rendered as XML attributes.

Returns:

Set of property names.

getAttrsProperty

protected BeanPropertyMeta getAttrsProperty()

The property that returns a map of XML attributes as key/value pairs.

Returns:

The bean property metadata, or null if there is no such method.

getAttrsPropertyName

protected String getAttrsPropertyName()

The name of the property that returns a map of XML attributes as key/value pairs.

Returns:

The bean property name, or null if there is no such method.

getCollapsedProperties

protected Map<String,BeanPropertyMeta> getCollapsedProperties()

The list of properties that should be rendered as collapsed child elements.
See @Xml(childName)

Returns:

Map of property names to property metadata.

getCollapsedPropertyNames

protected Set<String> getCollapsedPropertyNames()

The list of names of properties that should be rendered as collapsed child elements.

Returns:

Set of property names.

getContentPropertyName

protected String getContentPropertyName()

The name of the property that represents the inner XML content of this bean.

Returns:

The bean property name, or null if there is no such method.

getElementProperties

protected Map<String,BeanPropertyMeta> getElementProperties()

The list of properties that should be rendered as child elements.

Returns:

Map of property names to property metadata.

getElementPropertyNames

protected Set<String> getElementPropertyNames()

The list of names of properties that should be rendered as child elements.

Returns:

Set of property names.

getPropertyMeta

protected BeanPropertyMeta getPropertyMeta(String fieldName)

Returns bean property meta with the specified name.

This is identical to calling BeanMeta.getPropertyMeta(String) except it first retrieves the bean property meta based on the child name (e.g. a property whose name is "people", but whose child name is "person").

Parameters:

fieldName - The bean property name.

Returns:

The property metadata.