Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
SchemaTypeRegistry

Package | mx.rpc.xml
Class | public class SchemaTypeRegistry
Inheritance | SchemaTypeRegistry Object

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

XMLDecoder uses this class to map an XML Schema type by QName to an ActionScript Class so that it can create strongly typed objects when decoding content. If the type is unqualified the QName uri may be left null or set to the empty String.

It is important to note that the desired Class must be linked into the SWF and possess a default constructor in order for the XMLDecoder to create a new instance of the type, otherwise an anonymous Object will be used to hold the decoded properties.

Public Methods

| Method | Defined By
--- | --- | ---
|  | getClass(type:Object):Class Looks for a registered Class for the given type. | SchemaTypeRegistry
|  | getCollectionClass(type:Object):Class Returns the Class for the collection type represented by the given Qname or String. | SchemaTypeRegistry
|  | getInstance():SchemaTypeRegistry [static] Returns the sole instance of this singleton class, creating it if it does not already exist. | SchemaTypeRegistry
|  | registerClass(type:Object, definition:Object):void Maps a type QName to a Class definition. | SchemaTypeRegistry
|  | registerCollectionClass(type:Object, definition:Object):void Maps a type name to a collection Class. | SchemaTypeRegistry
|  | unregisterClass(type:Object):void Removes a Class from the registry for the given type. | SchemaTypeRegistry
|  | unregisterCollectionClass(type:Object):void Removes a collection Class from the registry for the given type. | SchemaTypeRegistry

Method Detail

getClass | () | method

`public function getClass(type:Object):Class`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Looks for a registered Class for the given type.

Parameters

| `type:Object` — The QName or String representing the type name.

Returns

| `Class` — Returns the Class for the given type, or null of the type has not been registered.

getCollectionClass | () | method |

`public function getCollectionClass(type:Object):Class`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the Class for the collection type represented by the given Qname or String.

Parameters

| `type:Object` — The QName or String representing the collection type name.

Returns

| `Class` — Returns the Class for the collection type represented by the given Qname or String.

getInstance | () | method |

`public static function getInstance():SchemaTypeRegistry`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the sole instance of this singleton class, creating it if it does not already exist.

Returns

| `SchemaTypeRegistry` — Returns the sole instance of this singleton class, creating it if it does not already exist.

registerClass | () | method |

`public function registerClass(type:Object, definition:Object):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Maps a type QName to a Class definition. The definition can be a String representation of the fully qualified class name or an instance of the Class itself.

Parameters

| `type:Object` — The QName or String representation of the type name.
| `definition:Object` — The Class itself or class name as a String.

registerCollectionClass | () | method |

`public function registerCollectionClass(type:Object, definition:Object):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Maps a type name to a collection Class. A collection is either the top level Array type, or an implementation of `mx.collections.IList`. The definition can be a String representation of the fully qualified class name or an instance of the Class itself.

Parameters

| `type:Object` — The QName or String representation of the type name.
| `definition:Object` — The Class itself or class name as a String.

unregisterClass | () | method |

`public function unregisterClass(type:Object):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes a Class from the registry for the given type.

Parameters

| `type:Object` — The QName or String representation of the type name.

unregisterCollectionClass | () | method |

`public function unregisterCollectionClass(type:Object):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes a collection Class from the registry for the given type.

Parameters

| `type:Object` — The QName or String representation of the collection type name.

Sun Mar 5 2017, 03:42 PM +11:00