cookxml.core.creator

Class DefaultCreator

java.lang.Object

cookxml.core.creator.DefaultCreator

All Implemented Interfaces:

DocletActionReporter, Creator

public class DefaultCreator
extends java.lang.Object
implements Creator, DocletActionReporter

This creator is for any classes that have a default constructor.

Since:

CookXml 1.0

Version:

$Id: DefaultCreator.java 255 2007-06-10 07:08:13Z coconut $

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Class[]	EMPTY_CLASS_PARAM
static java.lang.Object[]	EMPTY_OBJECT_PARAM

Method Summary

Modifier and Type	Method and Description
java.lang.Object	create(java.lang.String parentNS, java.lang.String parentTag, org.w3c.dom.Element elm, java.lang.Object parentObj, cookxml.core.DecodeEngine decodeEngine) This function is called whenever decodeEngine starts processing an element.
java.lang.Object	editFinished(java.lang.String parentNS, java.lang.String parentTag, org.w3c.dom.Element elm, java.lang.Object parentObj, java.lang.Object obj, cookxml.core.DecodeEngine decodeEngine) This function is called when the element and its subnodes have all been processed.
java.lang.Object[]	getActions(TagLibrary tagLibrary, java.lang.String tagNS, java.lang.String tag, java.lang.String attrNS, java.lang.String attr, java.lang.Class cl) This function returns the related function/constructor/field/methods that is called by creator/setter etc.
static Creator	getCreator(java.lang.Class targetClass)
static Creator	getCreator(java.lang.Class targetClass, boolean addAfterFinish) This function used to generate a creator.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CLASS_PARAM

public static final java.lang.Class[] EMPTY_CLASS_PARAM

EMPTY_OBJECT_PARAM

public static final java.lang.Object[] EMPTY_OBJECT_PARAM

Method Detail

getCreator

public static Creator getCreator(java.lang.Class targetClass)
                          throws CookXmlException

Throws:

CookXmlException

getCreator

public static Creator getCreator(java.lang.Class targetClass,
                                 boolean addAfterFinish)
                          throws CookXmlException

This function used to generate a creator.

Parameters:

targetClass - the class object

addAfterFinish - a flag that indicates not to add the object after its creation, but rather wait until all the setup has been done.

Returns:

a default creator if a default constructor can be found.

Throws:

CookXmlException

create

public java.lang.Object create(java.lang.String parentNS,
                               java.lang.String parentTag,
                               org.w3c.dom.Element elm,
                               java.lang.Object parentObj,
                               cookxml.core.DecodeEngine decodeEngine)
                        throws CreatorException

Description copied from interface: Creator

This function is called whenever decodeEngine starts processing an element. It should return an object that corresponds to the tag, or null to indicate no object could be created. If the object returned is of NoAdd type, then the object is not added to the parent object by decodeEngine.

There can be creative use of this function. For example, one could create another instance of CookXml that process the element differently, then call this instanceof decodeEngine to add the processed object to the parent, and then return null to tell this instance of decodeEngine/CookXml to stop processing the element.

Specified by:

create in interface Creator

Parameters:

parentNS - the parent tag namespace.

parentTag - the parent tag that contains this element

elm - the DOM element that contains all the information regarding this node.

parentObj - the parent object in the node

decodeEngine - the decode engine that is being used @throws CreatorException

Returns:

the object created, or null to tell decodeEngine to stop processing this node

Throws:

CreatorException

editFinished

public java.lang.Object editFinished(java.lang.String parentNS,
                                     java.lang.String parentTag,
                                     org.w3c.dom.Element elm,
                                     java.lang.Object parentObj,
                                     java.lang.Object obj,
                                     cookxml.core.DecodeEngine decodeEngine)
                              throws CookXmlException

Description copied from interface: Creator

This function is called when the element and its subnodes have all been processed. and about to be returned. For many helper objects that implement NoAdd, this is a great time to generate the real object and call the decodeEngine.addChild to add the real object to the parent.

Specified by:

editFinished in interface Creator

Parameters:

parentNS - the parent tag namespace.

parentTag - the parent element tag

elm - the DOM element that contains all the information regarding this node.

parentObj - the parent object of the parent element

obj - the object that was created by this create function

decodeEngine - the decode engine that is being used.

Returns:

the object. The purpose is to allow a helper object to return the real object.

Throws:

CookXmlException

getActions

public java.lang.Object[] getActions(TagLibrary tagLibrary,
                                     java.lang.String tagNS,
                                     java.lang.String tag,
                                     java.lang.String attrNS,
                                     java.lang.String attr,
                                     java.lang.Class cl)

Description copied from interface: DocletActionReporter

This function returns the related function/constructor/field/methods that is called by creator/setter etc. CookXmlDoc would then retrieve the JavaDoc associated with Member object and use it in the documentation.

Specified by:

getActions in interface DocletActionReporter

Parameters:

tagLibrary - the tag library being used.

tagNS - the namespace of the tag

tag - possible tag

attrNS - the namespace of the attribute

attr - the attribute

cl - the possible class

Returns:

A non-empty array of actions performed by this object.