Packageorg.orpheus.xml.bind.annotation
Classpublic class XmlElement
InheritanceXmlElement Inheritance AbstractAnnotation

Specifies that the annotated member is derived from an XML element tag.

XmlElement metadata has the following keys, all of which are optional:

 Keys:
 defaultValue="No Default"
 name="No Default"
 nameSpace="No Default"
 nillable="true|false"
 required="true|false"
 type="Class"
 


Example
[XmlElement(defaultValue="Andrew Lewisohn", name="author", nameSpace="http://metamorphosis.orpheus.org", nillable="true|false", required="true", type="String")]

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
  defaultValue : String
[read-only] Optional.
XmlElement
 Inheritedignore : Boolean
Optional.
AbstractAnnotation
  name : String
[read-only] Optional.
XmlElement
  nameSpace : String
[read-only] Optional.
XmlElement
  nillable : Boolean
[read-only] Optional.
XmlElement
 Inheritedprecedence : int
Determines the order of the Annotation in a sort.
AbstractAnnotation
  qualifiedName : QName
[read-only] The Name and Namespace as a Qualified Name.
XmlElement
  required : Boolean
[read-only] Optional.
XmlElement
  type : Class
[read-only] Optional.
XmlElement
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
  
XmlElement(metadata:Metadata)
Constructor.
XmlElement
  
annotationName():String
The name of this Annotation type.
XmlElement
  
toString():String
String representation of the object.
XmlElement
Protected Methods
 MethodDefined by
 Inherited
getValue(key:String):*
AbstractAnnotation
Property detail
defaultValueproperty
defaultValue:String  [read-only]

Optional. Default value if the property is null and nillable is false.

Implementation
    public function get defaultValue():String
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
nillableproperty 
nillable:Boolean  [read-only]

Optional. Value can be null.

Implementation
    public function get nillable():Boolean
qualifiedNameproperty 
qualifiedName:QName  [read-only]

The Name and Namespace as a Qualified Name.

Implementation
    public function get qualifiedName():QName
requiredproperty 
required:Boolean  [read-only]

Optional. Specifies whether the attribute is optional or required.

Implementation
    public function get required():Boolean
typeproperty 
type:Class  [read-only]

Optional. The ActionScript class being referenced.

Implementation
    public function get type():Class
Constructor detail
XmlElement()constructor
public function XmlElement(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