| Package | idv.cjcat.stardust.common.xml |
| Class | public class XMLBuilder |
XMLBuilder can generate Stardust elements' XML representations and reconstruct elements from existing XML data.
Every StardustElement objects can generate its XML representation through the StardustElement.toXML() method.
And they can reconstrcut configurations from existing XML data through the StardustElement.parseXML() method.
| Method | Defined by | ||
|---|---|---|---|
| XMLBuilder | |||
|
buildFromXML(xml:XML):void
Reconstructs elements from XML representations.
| XMLBuilder | ||
|
buildXML(element:StardustElement):XML
[static]
Generate the XML representation of an Stardust element.
| XMLBuilder | ||
|
getElementByName(name:String):StardustElement
After reconstructing elements through the
buildFromXML() method,
reconstructed elements can be extracted through this method. | XMLBuilder | ||
|
registerClass(elementClass:Class):void
To use
XMLBuilder with your custom subclasses of Stardust elements,
you must register your class and XML tag name first. | XMLBuilder | ||
|
registerClasses(classes:Array):void
Registers multiple classes.
| XMLBuilder | ||
|
registerClassesFromClassPackage(classPackage:ClassPackage):void
Registers multiple classes from a
ClassPackage object. | XMLBuilder | ||
|
unregisterClass(name:String):void
Undos the XML tag name registration.
| XMLBuilder | ||
| XMLBuilder | () | constructor |
public function XMLBuilder()
| buildFromXML | () | method |
public function buildFromXML(xml:XML):voidReconstructs elements from XML representations.
After calling this method, you may extract constrcuted elements through the getElementByName() method.
xml:XML |
| buildXML | () | method |
public static function buildXML(element:StardustElement):XMLGenerate the XML representation of an Stardust element.
All related elements' would be included in the XML representation.
Parameterselement:StardustElement |
XML |
| getElementByName | () | method |
public function getElementByName(name:String):StardustElement
After reconstructing elements through the buildFromXML() method,
reconstructed elements can be extracted through this method.
Each Stardust element has a name; this name is used to identify elements.
Parametersname:String |
StardustElement |
| registerClass | () | method |
public function registerClass(elementClass:Class):void
To use XMLBuilder with your custom subclasses of Stardust elements,
you must register your class and XML tag name first.
For example, if you register the MyAction class with XML tag name "HelloWorld",
XMLBuilder knows you are refering to the MyAction class when a
elementClass:Class |
| registerClasses | () | method |
public function registerClasses(classes:Array):voidRegisters multiple classes.
Parametersclasses:Array |
| registerClassesFromClassPackage | () | method |
public function registerClassesFromClassPackage(classPackage:ClassPackage):void
Registers multiple classes from a ClassPackage object.
classPackage:ClassPackage |
| unregisterClass | () | method |
public function unregisterClass(name:String):voidUndos the XML tag name registration.
Parametersname:String |