nextapp.echo.app.serial

Class Serializer

java.lang.Object

nextapp.echo.app.serial.Serializer

public class Serializer
extends java.lang.Object

Front-end for translating XML component/style to Style instances.

Method Summary

Modifier and Type	Method and Description
static Serializer	forClassLoader(java.lang.ClassLoader classLoader) Creates or retrieves a Serializer.
java.lang.Class	getClass(java.lang.String type) Returns a Class based on an XML type value.
SerialPropertyPeer	getSerialPropertyPeer(org.w3c.dom.Element propertyElement) Retrieves a SerialPropertyPeer specified by a type name in a property DOM element, if possible.
Style	loadStyle(SerialContext serialContext, java.lang.String componentType, org.w3c.dom.Element containerElement) Creates a Style object based on an XML property container.

Methods inherited from class java.lang.Object

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

Method Detail

forClassLoader

public static Serializer forClassLoader(java.lang.ClassLoader classLoader)

Creates or retrieves a Serializer.

Parameters:

classLoader - the ClassLoader to use for dynamically loading peer classes

Returns:

the Serializer

getClass

public java.lang.Class getClass(java.lang.String type)
                         throws java.lang.ClassNotFoundException

Returns a Class based on an XML type value. The provided type may be a java.lang shorthand, e.g., "s" for string, "b" for boolean. If the provided type is not fully qualified, a standard Echo property type is assumed, e.g. "Extent" will return the nextapp.echo.app.Extent class. If the property type is fully qualified, it will simply be loaded by the classloader.

Parameters:

type - the XML type value

Returns:

the represented Class

Throws:

java.lang.ClassNotFoundException - in the event that no class exists with the specified type

getSerialPropertyPeer

public SerialPropertyPeer getSerialPropertyPeer(org.w3c.dom.Element propertyElement)
                                         throws SerialException

Retrieves a SerialPropertyPeer specified by a type name in a property DOM element, if possible. Returns null in the event no type name is specified.

Parameters:

propertyElement - the property element, which may or may not specify a "t" attribute specifying the type name

Returns:

the SerialPropertyPeer, if it can be determined

Throws:

SerialException

loadStyle

public Style loadStyle(SerialContext serialContext,
                       java.lang.String componentType,
                       org.w3c.dom.Element containerElement)
                throws SerialException

Creates a Style object based on an XML property container.

Parameters:

serialContext - the SerialContext providing contextual information about the serialization

componentType - the component type for which the Style will be used

containerElement - the DOM element containing the style properties

Returns:

the generated Style

Throws:

SerialException