cookxml.core.setter

Class ConstantSetter

java.lang.Object

cookxml.core.setter.ConstantSetter

All Implemented Interfaces:

DocletActionReporter, Setter

public class ConstantSetter
extends java.lang.Object
implements Setter, DocletActionReporter

This setter is intended to locate a constant inside a class and returns the correct result. If the constant cannot be located, then the DefaultSetter is called on the original input. Thus, this setter can handle situtations where both constant values and arbitrary values can be assigned.

Since:

CookXml 1.0

Version:

$Id: ConstantSetter.java 224 2007-06-06 06:57:33Z coconut $

Constructor Summary

Constructors

Constructor and Description
ConstantSetter(java.lang.Class constantClass)
ConstantSetter(java.lang.Class constantClass, Setter setter)

Method Summary

Modifier and Type	Method and Description
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.
void	setAttribute(java.lang.String ns, java.lang.String tag, java.lang.String attrNS, java.lang.String attr, java.lang.Object obj, java.lang.Object value, cookxml.core.DecodeEngine decodeEngine) Set an attribute of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantSetter

public ConstantSetter(java.lang.Class constantClass)

ConstantSetter

public ConstantSetter(java.lang.Class constantClass,
                      Setter setter)

Method Detail

setAttribute

public void setAttribute(java.lang.String ns,
                         java.lang.String tag,
                         java.lang.String attrNS,
                         java.lang.String attr,
                         java.lang.Object obj,
                         java.lang.Object value,
                         cookxml.core.DecodeEngine decodeEngine)
                  throws java.lang.Exception

Description copied from interface: Setter

Set an attribute of the object.

Specified by:

setAttribute in interface Setter

Parameters:

ns - the namespace of the element.

tag - the tag of the element

attrNS - the namespace of the attribute

attr - the name of the attribute

obj - the object associated with the element

value - the value of the object. We didn't use the String type because it is entirely possible for an object of the child elements to call the setter.

decodeEngine - the DecodeEngine being used.

Throws:

java.lang.Exception - If the exception is not a SetterException, then it is wrapped inside one by the DecodeEngine and handled by the ExceptionHandler.

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.