org.apache.juneau.xml

Class XmlClassMeta

java.lang.Object

org.apache.juneau.ExtendedMeta

org.apache.juneau.ExtendedClassMeta

org.apache.juneau.xml.XmlClassMeta

public class XmlClassMeta
extends ExtendedClassMeta

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

Constructor Summary

Constructors

Constructor and Description
XmlClassMeta(ClassMeta<?> cm, XmlMetaProvider mp) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Xml	getAnnotation() Returns the @Xml annotation defined on the class.
protected String	getChildName() Returns the @Xml(childName) annotation defined on the class.
protected XmlFormat	getFormat() Returns the @Xml(format) annotation defined on the class.
Namespace	getNamespace() Returns the XML namespace associated with this class.

Methods inherited from class org.apache.juneau.ExtendedClassMeta

getClassMeta, getInnerClass

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlClassMeta

public XmlClassMeta(ClassMeta<?> cm,
                    XmlMetaProvider mp)

Constructor.

Parameters:

cm - The class that this annotation is defined on.

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

Method Detail

getAnnotation

protected Xml getAnnotation()

Returns the @Xml annotation defined on the class.

Returns:

The value of the annotation defined on the class, or null if annotation is not specified.

getFormat

protected XmlFormat getFormat()

Returns the @Xml(format) annotation defined on the class.

Returns:

The value of the annotation, or XmlFormat.DEFAULT if not specified.

getChildName

protected String getChildName()

Returns the @Xml(childName) annotation defined on the class.

Returns:

The value of the annotation, or null if not specified.

getNamespace

public Namespace getNamespace()

Returns the XML namespace associated with this class.

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

1. Class.
2. Package.
3. Superclasses.
4. Superclass packages.
5. Interfaces.
6. Interface packages.

Returns:

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