Packageorg.orpheus.xml.bind.annotation
Classpublic class XmlRootElement
InheritanceXmlRootElement Inheritance AbstractAnnotation

Defines a class level XML tag.

XmlRootElement metadata has the following keys:

 Keys:
 name="No Default"
 nameSpace="No Default"
 


Example
[XmlRootElement(name="author", nameSpace="http://metamorphosis.orpheus.org")]

Author: Andrew Lewisohn
Version: $Revision: 30 $, $Date: 2009-02-12 16:43:08 -0500 (Thu, 12 Feb 2009) $, $Author: alewisohn $
Since: 0.1



Public Properties
 PropertyDefined by
 Inheritedignore : Boolean
Optional.
AbstractAnnotation
  name : String
[read-only] Optional.
XmlRootElement
  nameSpace : String
[read-only] Optional.
XmlRootElement
 Inheritedprecedence : int
Determines the order of the Annotation in a sort.
AbstractAnnotation
  qualifiedName : QName
[read-only] The Name and Namespace as a Qualified Name.
XmlRootElement
Protected Properties
 PropertyDefined by
 Inheritedconstants : MarshallerConstants
Annotation names used in marshalling/unmarshalling.
AbstractAnnotation
 Inheritedmetadata : Metadata
Internally held reference to the defining metadata object.
AbstractAnnotation
Public Methods
 MethodDefined by
  
XmlRootElement(metadata:Metadata)
Constructor.
XmlRootElement
  
annotationName():String
The name of this Annotation type.
XmlRootElement
  
toString():String
String representation of the object.
XmlRootElement
Protected Methods
 MethodDefined by
 Inherited
getValue(key:String):*
AbstractAnnotation
Property detail
nameproperty
name:String  [read-only]

Optional. The name of the attribute. By default, the attribute name is derived from the property name.

Implementation
    public function get name():String
nameSpaceproperty 
nameSpace:String  [read-only]

Optional. The namespace of the attribute.

Implementation
    public function get nameSpace():String
qualifiedNameproperty 
qualifiedName:QName  [read-only]

The Name and Namespace as a Qualified Name.

Implementation
    public function get qualifiedName():QName
Constructor detail
XmlRootElement()constructor
public function XmlRootElement(metadata:Metadata)

Constructor.

Parameters
metadata:Metadata
Method detail
annotationName()method
public override function annotationName():String

The name of this Annotation type.

Returns
String
toString()method 
public override function toString():String

String representation of the object.

Returns
String