A B C D E F G H I L M N O P R S T U V 

A

AccessException - Exception in cookxml.core.exception
This exception is thrown whenever user specified to access a non-public variable but SecurityException is thrown, typically when running CookXml inside a sandbox or a SecurityManager.
AccessException(DecodeEngine, SecurityException, String) - Constructor for exception cookxml.core.exception.AccessException
 
add(String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.adder.CallFunctionAdder
 
add(String, String, Object, Object, DecodeEngine, Class, Class, String, Adder) - Static method in class cookxml.core.adder.CallFunctionAdder
 
add(String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.adder.CallSetterAdder
 
add(String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.adder.CompoundAdder
 
add(Adder) - Method in class cookxml.core.adder.CompoundAdder
 
add(String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.adder.DoNothingAdder
 
add(String, String, Object, Object, DecodeEngine) - Method in interface cookxml.core.interfaces.Adder
Add the child to the parent.
ADD_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
the attribute to specify whether or not to add the current object to the parent.
AddAction - Interface in cookxml.core.interfaces
This action dictates how DecodeEngine should perform its addChild function.
addAdder(String, Adder) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
Instead of creating an adder that does it all, this function internally creates a compound adder that combine the functionalities of individual specialized adders.
addChild(DecodeEngine, String, String, Element, Object, Object) - Method in interface cookxml.core.interfaces.AddAction
This function performs the actual addition of the child object to the parent object.
adder - Variable in exception cookxml.core.exception.AdderException
 
Adder - Interface in cookxml.core.interfaces
Adder is similar to setter, but without the attribute name.
AdderException - Exception in cookxml.core.exception
This exception can be generated only when an object is added to its parent.
AdderException(DecodeEngine, Throwable, Adder, String, String, Object, Object) - Constructor for exception cookxml.core.exception.AdderException
 
addTagLibrary(String, SingleNSTagLibrary) - Method in class cookxml.core.taglibrary.MultiNSTagLibrary
 
ArrayConstructor - Interface in cookxml.core.util
This class is used to create a primitive array.
ArrayException - Exception in cookxml.core.exception
 
ArrayException(String, Throwable, String, int) - Constructor for exception cookxml.core.exception.ArrayException
 
AssertExceptionHandler - Class in cookxml.core.exceptionhandler
This exception handler basically works like StrictExceptionHandler if assertion is enabled.
attribute - Variable in exception cookxml.core.exception.NoHandlerException
 
attribute - Variable in exception cookxml.core.exception.SetterException
 
attrNS - Variable in exception cookxml.core.exception.SetterException
 

B

BASE - Static variable in class cookxml.common.CommonLib
 
BooleanConverter - Class in cookxml.core.converter
This class converts a string "true" to Boolean.TRUE and such.
ByteConverter - Class in cookxml.core.converter
This class converts the first character of the string to a byte.

C

CallCtorConverter - Class in cookxml.core.converter
This converter is used to reduce the need to create custom converter classes.
CallFunctionAdder - Class in cookxml.core.adder
This Adder redirect the call to a different function, if the parameters match.
CallFunctionAdder(String, Class, Class) - Constructor for class cookxml.core.adder.CallFunctionAdder
 
CallFunctionConverter - Class in cookxml.core.converter
This converter is used to reduce the need to create custom converter classes.
CallFunctionSetter - Class in cookxml.core.setter
This Setter redirect the call to a function, if the parameters match.
CallFunctionSetter(String, Class, Class) - Constructor for class cookxml.core.setter.CallFunctionSetter
 
CallFunctionSetter(String, Method, Class, Class) - Constructor for class cookxml.core.setter.CallFunctionSetter
 
CallSetterAdder - Class in cookxml.core.adder
This Adder redirect the call to set attribute instead, if the parameters match.
CallSetterAdder(String, Class, Class) - Constructor for class cookxml.core.adder.CallSetterAdder
 
CharConverter - Class in cookxml.core.converter
This class returns the first character of the string.
child - Variable in exception cookxml.core.exception.AdderException
 
className - Variable in exception cookxml.core.exception.ArrayException
 
ClassUtils - Class in cookxml.core.util
A collection of reflection/class utilities.
ClassUtils() - Constructor for class cookxml.core.util.ClassUtils
 
cleanup(DecodeEngine) - Method in interface cookxml.core.interfaces.CleanupHook
 
CleanupException - Exception in cookxml.core.exception
This exception is thrown by CleanupHook to indicate errors.
CleanupException(DecodeEngine, Throwable, CleanupHook) - Constructor for exception cookxml.core.exception.CleanupException
 
cleanupHook - Variable in exception cookxml.core.exception.CleanupException
The CleanupHook that caused the problem.
CleanupHook - Interface in cookxml.core.interfaces
This interface defines function objects which can be added to DecodeEngine
CommonLib - Class in cookxml.common
Setup common component tags.
CompoundAdder - Class in cookxml.core.adder
This adder is used internally by InheritableTagLibrary to combine several individual adders into one.
CompoundAdder() - Constructor for class cookxml.core.adder.CompoundAdder
 
ConstantSetter - Class in cookxml.core.setter
This setter is intended to locate a constant inside a class and returns the correct result.
ConstantSetter(Class) - Constructor for class cookxml.core.setter.ConstantSetter
 
ConstantSetter(Class, Setter) - Constructor for class cookxml.core.setter.ConstantSetter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.BooleanConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.ByteConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.CallCtorConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.CallFunctionConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.CharConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.DocumentElementConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.DoubleConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.FloatConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.IntConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.ObjectConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.ShortConverter
 
convert(String, DecodeEngine) - Method in class cookxml.core.converter.URLConverter
 
convert(String, DecodeEngine) - Method in interface cookxml.core.interfaces.Converter
Convert a string value into an object type.
converter - Variable in exception cookxml.core.exception.ConverterException
 
Converter - Interface in cookxml.core.interfaces
Converters are used to convert a string (obtained from an attribute value) to the actual value needed by the setter.
ConverterException - Exception in cookxml.core.exception
This exception can be generated only when a converter is called to convert a string to a target object type.
ConverterException(DecodeEngine, Throwable, Converter, String) - Constructor for exception cookxml.core.exception.ConverterException
 
cookXml - Variable in exception cookxml.core.exception.CookXmlException
 
cookxml.common - package cookxml.common
 
cookxml.cookxml - package cookxml.cookxml
 
cookxml.core.adder - package cookxml.core.adder
 
cookxml.core.converter - package cookxml.core.converter
 
cookxml.core.creator - package cookxml.core.creator
 
cookxml.core.doclet - package cookxml.core.doclet
 
cookxml.core.exception - package cookxml.core.exception
 
cookxml.core.exceptionhandler - package cookxml.core.exceptionhandler
 
cookxml.core.interfaces - package cookxml.core.interfaces
 
cookxml.core.setter - package cookxml.core.setter
 
cookxml.core.stringhook - package cookxml.core.stringhook
 
cookxml.core.taglibrary - package cookxml.core.taglibrary
 
cookxml.core.util - package cookxml.core.util
 
CookXmlException - Exception in cookxml.core.exception
This is the base class for all CookXml related exceptions.
CookXmlException() - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlException(String) - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlException(Throwable) - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlException(String, Throwable) - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlException(CookXml) - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlException(DecodeEngine) - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlException(CookXml, DecodeEngine) - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlException(CookXml, DecodeEngine, String, Throwable) - Constructor for exception cookxml.core.exception.CookXmlException
 
CookXmlLib - Class in cookxml.cookxml
This class creates a CookXml tag library for CookXml special attributes.
CookXmlLib() - Constructor for class cookxml.cookxml.CookXmlLib
 
create(String, String, Element, Object, DecodeEngine) - Method in class cookxml.core.creator.DefaultCreator
 
create(String, String, Element, Object, DecodeEngine) - Method in class cookxml.core.creator.GetInstanceCreator
 
create(String, String, Element, Object, DecodeEngine) - Method in class cookxml.core.creator.HelperCreator
 
create(String, String, Element, Object, DecodeEngine) - Method in class cookxml.core.creator.IncludeCreator
 
create(String, String, Element, Object, DecodeEngine) - Method in class cookxml.core.creator.NullCreator
 
create(String, String, Element, Object, DecodeEngine) - Method in interface cookxml.core.interfaces.Creator
This function is called whenever decodeEngine starts processing an element.
create(int) - Method in interface cookxml.core.util.ArrayConstructor
 
createTagLibrary(TagLibrary) - Static method in class cookxml.common.CommonLib
Create a new instance of common tag library.
createTagLibrary() - Static method in class cookxml.cookxml.CookXmlLib
 
creator - Variable in exception cookxml.core.exception.CreatorException
 
Creator - Interface in cookxml.core.interfaces
This interface handles object creation.
CreatorException - Exception in cookxml.core.exception
This exception can be generated only when a Creator is called to create an object for a given tag.
CreatorException(DecodeEngine, Throwable, Creator, String, String, Element, Object) - Constructor for exception cookxml.core.exception.CreatorException
 

D

DebugExceptionHandler - Class in cookxml.core.exceptionhandler
This exception handler output the message and exception if assertion is enabled.
decodeEngine - Variable in exception cookxml.core.exception.CookXmlException
 
DefaultAdder - Class in cookxml.core.adder
This adder provides a usual way for adding an object created from a child element to the object created from the parent element.
DefaultCreator - Class in cookxml.core.creator
This creator is for any classes that have a default constructor.
DefaultSetter - Class in cookxml.core.setter
This setter attempts to call Java setter functions with the converted attribute values.
doc - Variable in class cookxml.core.util.DocumentElement
 
DocletActionReporter - Interface in cookxml.core.doclet
This function returns the related function/constructor/field/methods that is called by creator/setter etc.
DocletSetter - Interface in cookxml.core.doclet
This interface should be extended by all general setters (that is the ones used by DecodeEngine as default in case of missing specific setter for a tag) that wish to to report potential candidates of attributes.
DocletTagLibrary - Interface in cookxml.core.doclet
This interface is used for tag libraries that are wish to carry the capability of being documented using CookXmlDoc.
DocletUtils - Class in cookxml.core.util
 
DocletUtils() - Constructor for class cookxml.core.util.DocletUtils
 
DocumentElement - Class in cookxml.core.util
 
DocumentElement(Document, Element) - Constructor for class cookxml.core.util.DocumentElement
 
DocumentElementConverter - Class in cookxml.core.converter
Convert a string into DocumentELement as if it is an include path.
DoNothingAdder - Class in cookxml.core.adder
As the name implies, this adder does exactly nothing.
DoNothingSetter - Class in cookxml.core.setter
This setter is used to prevent useless setting attributes, ones that are handled elsewhere.
DoubleConverter - Class in cookxml.core.converter
This converter converts a string represenation into double.

E

editFinished(String, String, Element, Object, Object, DecodeEngine) - Method in class cookxml.core.creator.DefaultCreator
 
editFinished(String, String, Element, Object, Object, DecodeEngine) - Method in class cookxml.core.creator.GetInstanceCreator
 
editFinished(String, String, Element, Object, Object, DecodeEngine) - Method in class cookxml.core.creator.HelperCreator
 
editFinished(String, String, Element, Object, Object, DecodeEngine) - Method in class cookxml.core.creator.IncludeCreator
 
editFinished(String, String, Element, Object, Object, DecodeEngine) - Method in class cookxml.core.creator.NullCreator
 
editFinished(String, String, Element, Object, Object, DecodeEngine) - Method in interface cookxml.core.interfaces.Creator
This function is called when the element and its subnodes have all been processed.
element - Variable in exception cookxml.core.exception.CreatorException
 
element - Variable in class cookxml.core.util.DocumentElement
 
EMPTY_CLASS_PARAM - Static variable in class cookxml.core.creator.DefaultCreator
 
EMPTY_CLASS_PARAM - Static variable in class cookxml.core.creator.HelperCreator
 
EMPTY_OBJECT_PARAM - Static variable in class cookxml.core.creator.DefaultCreator
 
EMPTY_OBJECT_PARAM - Static variable in class cookxml.core.creator.HelperCreator
 
ExceptionHandler - Interface in cookxml.core.interfaces
This is the interface for handlers that deal with exceptions generated while CookXml is decoding XML.

F

field - Variable in exception cookxml.core.exception.VariableHandlerException
 
FloatConverter - Class in cookxml.core.converter
This converter converts a string represenation into float.
FUNC_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
the direct function call attribute
FuncAdderException - Exception in cookxml.core.exception
This exception is generated when DecodeEngine couldn't find an Adder in the tag library for the given parent and child.
FuncAdderException(DecodeEngine, Throwable, String, String, String, Object, Object) - Constructor for exception cookxml.core.exception.FuncAdderException
 
FUNCTION - Static variable in class cookxml.core.adder.DefaultAdder
 
function - Variable in exception cookxml.core.exception.FuncAdderException
 
FunctionHandlerException - Exception in cookxml.core.exception
Generated by FunctionHandler.
FunctionHandlerException(DecodeEngine, Throwable, Object, Object, Method) - Constructor for exception cookxml.core.exception.FunctionHandlerException
 
functionName - Variable in exception cookxml.core.exception.NoFactoryFunctionException
 

G

getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.adder.CallFunctionAdder
 
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.adder.CallSetterAdder
 
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.adder.CompoundAdder
 
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.creator.DefaultCreator
 
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.creator.GetInstanceCreator
 
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.creator.HelperCreator
 
getActions(TagLibrary, String, String, String, String, Class) - Method in interface cookxml.core.doclet.DocletActionReporter
This function returns the related function/constructor/field/methods that is called by creator/setter etc.
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.setter.CallFunctionSetter
 
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.setter.ConstantSetter
 
getActions(TagLibrary, String, String, String, String, Class) - Method in class cookxml.core.setter.DefaultSetter
 
getAdder(String, Class, Class) - Static method in class cookxml.core.adder.CallFunctionAdder
 
getAdder(Adder, Adder) - Static method in class cookxml.core.adder.CompoundAdder
 
getAdder(String, String) - Method in interface cookxml.core.interfaces.TagLibrary
Get the Adder delegate associated with the namespace and tag.
getAdder(String, String) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
 
getAdder(String, String) - Method in class cookxml.core.taglibrary.MultiNSTagLibrary
 
getAdder(String, String) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getArray(String, int) - Static method in class cookxml.core.util.ClassUtils
 
getArray(Class, int) - Static method in class cookxml.core.util.ClassUtils
 
getAttributeNode(Element, String, String) - Static method in class cookxml.cookxml.Util
Retrieve the attribute node that corresponds to the namespaceURI and localName.
getAttributeNodeNS(Element, String, String) - Static method in class cookxml.cookxml.Util
Retrieve the attribute node that corresponds to the namespaceURI and localName.
getAttributes(Class) - Method in interface cookxml.core.doclet.DocletSetter
This function reports potential attributes that can be handled by this setter for a given class.
getAttributes(String, String) - Method in interface cookxml.core.doclet.DocletTagLibrary
This function reports the attributes associated with a particular tag.
getAttributes(Class) - Method in class cookxml.core.setter.DefaultSetter
 
getAttributes(String, String) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
 
getAttributes(String, String) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getConstantValue(Class, String) - Static method in class cookxml.core.util.ClassUtils
 
getConverter(Class) - Static method in class cookxml.core.converter.CallCtorConverter
 
getConverter(Class, String) - Static method in class cookxml.core.converter.CallFunctionConverter
 
getConverter(String, Class) - Method in interface cookxml.core.interfaces.TagLibrary
Get the Converter that converts a string attribute value into the target class.
getConverter(String, Class) - Method in class cookxml.core.taglibrary.MultiNSTagLibrary
 
getConverter(String, Class) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getConverters(String) - Method in interface cookxml.core.doclet.DocletTagLibrary
This function reports the converters associated with a namespace.
getConverters(String) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getCreator(Class) - Static method in class cookxml.core.creator.DefaultCreator
 
getCreator(Class, boolean) - Static method in class cookxml.core.creator.DefaultCreator
This function used to generate a creator.
getCreator(Class, String) - Static method in class cookxml.core.creator.GetInstanceCreator
This function used to generate a creator that creates a new object using the public static function specified.
getCreator(Class, String, boolean) - Static method in class cookxml.core.creator.GetInstanceCreator
This function used to generate a creator that creates a new object using the public static function specified.
getCreator(Class) - Static method in class cookxml.core.creator.HelperCreator
This function used to generate a creator.
getCreator(DecodeEngine, String, String, Element, Object) - Method in interface cookxml.core.interfaces.SpecialCreator
 
getCreator(String, String) - Method in interface cookxml.core.interfaces.TagLibrary
Get the Creator object factory associated with the namespace and tag.
getCreator(String, String) - Method in class cookxml.core.taglibrary.MultiNSTagLibrary
 
getCreator(String, String) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getElement(String, DecodeEngine) - Static method in class cookxml.core.util.IncludeUtils
This function is used to find the element to be included.
getElement(String, Document, DocumentBuilder) - Static method in class cookxml.core.util.IncludeUtils
This function is used to find the element to be included.
getElement(String, ClassLoader, Document, DocumentBuilder) - Static method in class cookxml.core.util.IncludeUtils
This function is used to find the element to be included.
getElementById(Element, String) - Static method in class cookxml.core.util.IncludeUtils
This function retrieves the element in the document that has the given id.
getEquivalentClass(Class) - Static method in class cookxml.core.util.ClassUtils
 
getEquivalentClass(String) - Static method in class cookxml.core.util.ClassUtils
 
getField(Object, String) - Static method in class cookxml.core.util.ClassUtils
 
getField(Object, String, boolean) - Static method in class cookxml.core.util.ClassUtils
 
getFinalObject() - Method in interface cookxml.core.interfaces.Helper
 
getInstance() - Static method in class cookxml.core.adder.DefaultAdder
 
getInstance() - Static method in class cookxml.core.adder.DoNothingAdder
This is a frequently used adder.
getInstance() - Static method in class cookxml.core.converter.BooleanConverter
 
getInstance() - Static method in class cookxml.core.converter.ByteConverter
 
getInstance() - Static method in class cookxml.core.converter.CharConverter
 
getInstance() - Static method in class cookxml.core.converter.DocumentElementConverter
 
getInstance() - Static method in class cookxml.core.converter.DoubleConverter
 
getInstance() - Static method in class cookxml.core.converter.FloatConverter
 
getInstance() - Static method in class cookxml.core.converter.IntConverter
 
getInstance() - Static method in class cookxml.core.converter.ObjectConverter
 
getInstance() - Static method in class cookxml.core.converter.ShortConverter
 
getInstance() - Static method in class cookxml.core.converter.URLConverter
 
getInstance() - Static method in class cookxml.core.creator.IncludeCreator
 
getInstance() - Static method in class cookxml.core.creator.NullCreator
 
getInstance() - Static method in class cookxml.core.exceptionhandler.AssertExceptionHandler
 
getInstance() - Static method in class cookxml.core.exceptionhandler.DebugExceptionHandler
 
getInstance() - Static method in class cookxml.core.exceptionhandler.StrictExceptionHandler
 
getInstance() - Static method in class cookxml.core.setter.DefaultSetter
 
getInstance() - Static method in class cookxml.core.setter.DoNothingSetter
 
GetInstanceCreator - Class in cookxml.core.creator
This creator creates a new object by calling a static function.
getNameSpace() - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
Get the namespace of the tag library.
getNameSpaces() - Method in interface cookxml.core.doclet.DocletTagLibrary
This function reports the namespaces this tag library holds.
getNameSpaces() - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getParent() - Method in interface cookxml.core.doclet.DocletTagLibrary
This function reports the parent tagLibrary.
getParent() - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getParentTags(String) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
Retrieve the direct parent tags.
getParentTags(String, String) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
This for documentation purpose to retrieve the direct parent tags.
getProperty(String) - Method in exception cookxml.core.exception.CookXmlException
 
getSetter(String, String, String, String) - Method in interface cookxml.core.interfaces.TagLibrary
Get the Setter delegate associated with the namespace and tag.
getSetter(String, Class, Class) - Static method in class cookxml.core.setter.CallFunctionSetter
 
getSetter(String, String, String, String) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
 
getSetter(String, String, String, String) - Method in class cookxml.core.taglibrary.MultiNSTagLibrary
 
getSetter(String, String, String, String) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getSingletonTagLibrary() - Static method in class cookxml.common.CommonLib
Get the singleton instance of the Common tag library.
getSingletonTagLibrary() - Static method in class cookxml.cookxml.CookXmlLib
Get the singleton instance of the CookXml tag library.
getSpecialCreator() - Method in interface cookxml.core.interfaces.TagLibrary
Get the SpecialCreator for the TagLibrary.
getSpecialCreator() - Method in class cookxml.core.taglibrary.MultiNSTagLibrary
 
getSpecialCreator() - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getTagLibrary(String) - Method in class cookxml.core.taglibrary.MultiNSTagLibrary
 
getTags() - Method in interface cookxml.core.doclet.DocletTagLibrary
This function reports the tags having the creators and are located inside this tag library.
getTags() - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
 
getText(Element) - Static method in class cookxml.core.util.TextUtils
Get the text of an element.
getTranslatedString(String, Object, String, String, DecodeEngine) - Method in interface cookxml.core.interfaces.StringHook
this function is used to substitute a string specified in XML with a different string.
getTranslatedString(String, Object, String, String, DecodeEngine) - Method in class cookxml.core.stringhook.ResourceBundleStringHook
 
getVariable(String, DecodeEngine) - Method in interface cookxml.core.interfaces.VarLookup
Get a variable by its name.

H

handleException(String, Exception) - Method in class cookxml.core.exceptionhandler.AssertExceptionHandler
 
handleException(String, Exception) - Method in class cookxml.core.exceptionhandler.DebugExceptionHandler
 
handleException(String, Exception) - Method in class cookxml.core.exceptionhandler.StrictExceptionHandler
 
handleException(String, Exception) - Method in interface cookxml.core.interfaces.ExceptionHandler
This function handles the exception.
Handler - Interface in cookxml.core.interfaces
This interface is used for setting an attribute value to an object.
HandlerException - Exception in cookxml.core.exception
This exception is generated by Variablehandler or FunctionHandler.
HandlerException(DecodeEngine, Throwable, Object, Object) - Constructor for exception cookxml.core.exception.HandlerException
 
Helper - Interface in cookxml.core.interfaces
This interface is intended to reduce the need to create a custom Creator when it is necessary to use helper objects.
HelperCreator - Class in cookxml.core.creator
This creator is for any helper classes that have a default constructor.
HOOK_CHAR - Static variable in class cookxml.core.stringhook.ResourceBundleStringHook
 

I

ID_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
write the id reference
ID_SEPARATOR - Static variable in class cookxml.core.creator.IncludeCreator
 
IDREF_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
read the id reference
IDREF_PREFIX - Static variable in class cookxml.core.converter.ObjectConverter
 
IncludeCreator - Class in cookxml.core.creator
This creator is used to implement a creator that is used to include another XML document.
IncludeCreator() - Constructor for class cookxml.core.creator.IncludeCreator
 
IncludeUtils - Class in cookxml.core.util
 
IncludeUtils() - Constructor for class cookxml.core.util.IncludeUtils
 
InheritableTagLibrary - Class in cookxml.core.taglibrary
This tag library class avoids the hassele of setting up all the things (adders and setters) for a tag.
InheritableTagLibrary() - Constructor for class cookxml.core.taglibrary.InheritableTagLibrary
Construct a tag library that doesn't have a parent.
InheritableTagLibrary(TagLibrary) - Constructor for class cookxml.core.taglibrary.InheritableTagLibrary
Construct a tag library with a parent.
inheritTag(String, String, String) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
Create a tag inheritance.
inheritTag(String, String) - Method in class cookxml.core.taglibrary.InheritableTagLibrary
create a tag inheritance.
input - Variable in exception cookxml.core.exception.InvalidInputException
 
IntConverter - Class in cookxml.core.converter
This converter converts a string represenation into integer.
InvalidInputException - Exception in cookxml.core.exception
Called by CookXml's xmlDecode if an input is an unknown type.
InvalidInputException(Object) - Constructor for exception cookxml.core.exception.InvalidInputException
 
invoke(String, Object, Object, DecodeEngine) - Method in interface cookxml.core.interfaces.Handler
this function is used to assign the value to the object either through a function setter or directly through variable assignment.
isReadAccess - Variable in exception cookxml.core.exception.VarLookupException
 

L

LISTENERS - Static variable in class cookxml.common.CommonLib
 

M

MAP - Static variable in class cookxml.common.CommonLib
 
mergeMap(Map, Map) - Static method in class cookxml.core.util.DocletUtils
Merge two maps.
method - Variable in exception cookxml.core.exception.FunctionHandlerException
 
MultiNSTagLibrary - Class in cookxml.core.taglibrary
This tag library pools several SingleNSTagLibrary together to serve as a single TagLibrary.
MultiNSTagLibrary() - Constructor for class cookxml.core.taglibrary.MultiNSTagLibrary
 
MultiNSTagLibrary(TagLibrary) - Constructor for class cookxml.core.taglibrary.MultiNSTagLibrary
 

N

name - Variable in exception cookxml.core.exception.VarLookupException
 
NAMESPACE - Static variable in class cookxml.common.CommonLib
this is the namespace for CookXml Common tags
NAMESPACE - Static variable in class cookxml.cookxml.CookXmlLib
 
nameSpace - Variable in exception cookxml.core.exception.UnknownNameSpaceException
 
NOADD - Static variable in class cookxml.common.CommonLib
 
NoAdd - Interface in cookxml.core.interfaces
This interface should be implemented by all objects that do not wish to be added to the parent object.
NoAdderException - Exception in cookxml.core.exception
This exception is generated when DecodeEngine couldn't find an Adder in the tag library for the given parent and child.
NoAdderException(DecodeEngine, String, String, Object, Object) - Constructor for exception cookxml.core.exception.NoAdderException
 
NoConstructorException - Exception in cookxml.core.exception
 
NoConstructorException(Class) - Constructor for exception cookxml.core.exception.NoConstructorException
 
NoCreatorException - Exception in cookxml.core.exception
This exception is generated when DecodeEngine couldn't find a creator in the tag library for the given tag.
NoCreatorException(DecodeEngine, String, String, String, Element, Object) - Constructor for exception cookxml.core.exception.NoCreatorException
 
NoDefaultConstructorException - Exception in cookxml.core.exception
This exception is used by DefaultCreator to indicate that a particular class does not have a default constructor.
NoDefaultConstructorException(Class) - Constructor for exception cookxml.core.exception.NoDefaultConstructorException
 
NoFactoryFunctionException - Exception in cookxml.core.exception
This exception is used by GetInstanceCreator to indicate that a particular class does not have the specified public static function.
NoFactoryFunctionException(Class, String) - Constructor for exception cookxml.core.exception.NoFactoryFunctionException
 
NoHandlerException - Exception in cookxml.core.exception
 
NoHandlerException(DecodeEngine, String, String, String, Object, Object) - Constructor for exception cookxml.core.exception.NoHandlerException
 
NoSetterException - Exception in cookxml.core.exception
This exception is generated when DecodeEngine couldn't find a setter in the tag library for the given tag and attribute.
NoSetterException(DecodeEngine, String, String, String, String, Object, Object) - Constructor for exception cookxml.core.exception.NoSetterException
 
NULL_VAR - Static variable in class cookxml.core.util.ClassUtils
 
NullCreator - Class in cookxml.core.creator
This creator creates a null object and forces it to be added/set to the parent object.

O

object - Variable in exception cookxml.core.exception.HandlerException
 
object - Variable in exception cookxml.core.exception.NoHandlerException
 
object - Variable in exception cookxml.core.exception.SetterException
 
ObjectConverter - Class in cookxml.core.converter
This converter treats the string as if an pointer representing an object with id or variable names.

P

parent - Variable in exception cookxml.core.exception.AdderException
 
parentNS - Variable in exception cookxml.core.exception.AdderException
 
parentNS - Variable in exception cookxml.core.exception.CreatorException
 
parentObject - Variable in exception cookxml.core.exception.CreatorException
 
parentTag - Variable in exception cookxml.core.exception.AdderException
 
parentTag - Variable in exception cookxml.core.exception.CreatorException
 
PREFIX - Static variable in class cookxml.core.setter.DefaultSetter
 
produceException(String, Exception) - Static method in class cookxml.core.exceptionhandler.StrictExceptionHandler
 

R

readText(String, ClassLoader) - Static method in class cookxml.core.util.TextUtils
This function reads from the file/resource using the ClassLoader provided.
readText(String) - Static method in class cookxml.core.util.TextUtils
This function reads from the file/resource using the default class loader for CookXml.
ResourceBundleStringHook - Class in cookxml.core.stringhook
This StringHook class translate the string that starts with HOOK_CHAR (default to @) using the resource bundle.
ResourceBundleStringHook(ResourceBundle) - Constructor for class cookxml.core.stringhook.ResourceBundleStringHook
 

S

set(String, String, Object, Object, DecodeEngine, Class, Class, String) - Static method in class cookxml.core.setter.CallFunctionSetter
 
setAdder(String, Adder) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
Insert the adder for a tag into the tag library.
setArray(Object, int, Collection) - Static method in class cookxml.core.util.ClassUtils
 
SETAS_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
the setter attribute
setAttribute(String, String, String, String, Object, Object, DecodeEngine) - Method in interface cookxml.core.interfaces.Setter
Set an attribute of the object.
setAttribute(String, String, String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.setter.CallFunctionSetter
 
setAttribute(String, String, String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.setter.ConstantSetter
 
setAttribute(String, String, String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.setter.DefaultSetter
 
setAttribute(String, String, String, String, Object, Object, DecodeEngine) - Method in class cookxml.core.setter.DoNothingSetter
 
setConverter(Class, Converter) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
Insert a class converter into the tag library.
setCreator(String, Creator) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
Insert an object factory (Creator) for a tag into the tag library.
setField(Object, String, Object) - Static method in class cookxml.core.util.ClassUtils
 
setField(Object, String, Object, boolean) - Static method in class cookxml.core.util.ClassUtils
 
setNameSpace(String) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
Set the namespace of the tag library.
setProperty(String, Object) - Method in exception cookxml.core.exception.CookXmlException
 
setSetter(String, String, Setter) - Method in class cookxml.core.taglibrary.SingleNSTagLibrary
Insert a setter delegate for a tag and the attribute into the tag library.
setter - Variable in exception cookxml.core.exception.SetterException
 
Setter - Interface in cookxml.core.interfaces
This interface is used by all setters that handle request to set a value to the object.
SetterException - Exception in cookxml.core.exception
This exception can be generated only when a setter is called to set an attribute for an object.
SetterException(DecodeEngine, Throwable, Setter, String, String, String, String, Object, Object) - Constructor for exception cookxml.core.exception.SetterException
 
SetupException - Exception in cookxml.core.exception
This exception is used to represent all types of exceptions related to setting up the tag library.
SetupException() - Constructor for exception cookxml.core.exception.SetupException
 
SetupException(String) - Constructor for exception cookxml.core.exception.SetupException
 
SetupException(Throwable) - Constructor for exception cookxml.core.exception.SetupException
 
SetupException(String, Throwable) - Constructor for exception cookxml.core.exception.SetupException
 
SetupException(CookXml) - Constructor for exception cookxml.core.exception.SetupException
 
SetupException(DecodeEngine) - Constructor for exception cookxml.core.exception.SetupException
 
SetupException(CookXml, DecodeEngine) - Constructor for exception cookxml.core.exception.SetupException
 
SetupException(CookXml, DecodeEngine, String, Throwable) - Constructor for exception cookxml.core.exception.SetupException
 
setupTags(InheritableTagLibrary) - Static method in class cookxml.common.CommonLib
Setup common component tags for a tag library.
setVariable(String, Object, DecodeEngine) - Method in interface cookxml.core.interfaces.VarLookup
Set a variable by its name.
ShortConverter - Class in cookxml.core.converter
This converter converts a string represenation into short.
SingleNSTagLibrary - Class in cookxml.core.taglibrary
This class by itself can only add creators, adders, setters, and converters for a single namespace.
SingleNSTagLibrary() - Constructor for class cookxml.core.taglibrary.SingleNSTagLibrary
The default constructor that creates an instance of SingleNSTagLibrary without a parent.
SingleNSTagLibrary(TagLibrary) - Constructor for class cookxml.core.taglibrary.SingleNSTagLibrary
The constructor that creates an instance of SingleNSTagLibrary with a parent tag library.
size - Variable in exception cookxml.core.exception.ArrayException
 
SpecialCreator - Interface in cookxml.core.interfaces
This interface is used for the rare occation when one wants to create an object not based on the element tag name, but other characteristics.
StrictExceptionHandler - Class in cookxml.core.exceptionhandler
This exception handler will re-throw the exception, which immediately interrupt any further XML decoding.
StringHook - Interface in cookxml.core.interfaces
This interface is used to intercept the string values obtained in the xml document.

T

tag - Variable in exception cookxml.core.exception.NoCreatorException
 
tag - Variable in exception cookxml.core.exception.NoHandlerException
 
tag - Variable in exception cookxml.core.exception.SetterException
 
TAG_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
the tag attribute for casting the current tag into a new tag name.
tagClass - Variable in exception cookxml.core.exception.NoDefaultConstructorException
 
tagClass - Variable in exception cookxml.core.exception.NoFactoryFunctionException
 
TagLibrary - Interface in cookxml.core.interfaces
A tag library should contain creators, setters, adders, and converters.
tagNS - Variable in exception cookxml.core.exception.SetterException
 
targetClass - Variable in exception cookxml.core.exception.NoConstructorException
 
TextUtils - Class in cookxml.core.util
Useful functions dealing with texts.
TextUtils() - Constructor for class cookxml.core.util.TextUtils
 
THIS_VAR - Static variable in class cookxml.core.util.ClassUtils
 
toString() - Method in class cookxml.core.adder.CallFunctionAdder
 
toString() - Method in class cookxml.core.adder.CompoundAdder
 
toString() - Method in exception cookxml.core.exception.AccessException
 
toString() - Method in exception cookxml.core.exception.AdderException
 
toString() - Method in exception cookxml.core.exception.ArrayException
 
toString() - Method in exception cookxml.core.exception.CleanupException
 
toString() - Method in exception cookxml.core.exception.ConverterException
 
toString() - Method in exception cookxml.core.exception.CreatorException
 
toString() - Method in exception cookxml.core.exception.FuncAdderException
 
toString() - Method in exception cookxml.core.exception.FunctionHandlerException
 
toString() - Method in exception cookxml.core.exception.InvalidInputException
 
toString() - Method in exception cookxml.core.exception.NoAdderException
 
toString() - Method in exception cookxml.core.exception.NoConstructorException
 
toString() - Method in exception cookxml.core.exception.NoCreatorException
 
toString() - Method in exception cookxml.core.exception.NoDefaultConstructorException
 
toString() - Method in exception cookxml.core.exception.NoFactoryFunctionException
 
toString() - Method in exception cookxml.core.exception.NoHandlerException
 
toString() - Method in exception cookxml.core.exception.NoSetterException
 
toString() - Method in exception cookxml.core.exception.SetterException
 
toString() - Method in exception cookxml.core.exception.UnknownNameSpaceException
 
toString() - Method in exception cookxml.core.exception.VariableHandlerException
 
toString() - Method in exception cookxml.core.exception.VarLookupException
 

U

UnknownNameSpaceException - Exception in cookxml.core.exception
 
UnknownNameSpaceException(String) - Constructor for exception cookxml.core.exception.UnknownNameSpaceException
 
URLConverter - Class in cookxml.core.converter
This converter converts a string represenation into url.
Util - Class in cookxml.cookxml
 
Util() - Constructor for class cookxml.cookxml.Util
 

V

value - Variable in exception cookxml.core.exception.ConverterException
 
value - Variable in exception cookxml.core.exception.HandlerException
 
value - Variable in exception cookxml.core.exception.NoHandlerException
 
value - Variable in exception cookxml.core.exception.SetterException
 
value - Variable in exception cookxml.core.exception.VarLookupException
 
VAR_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
write access to the variable
variable - Variable in exception cookxml.core.exception.AccessException
 
VariableHandlerException - Exception in cookxml.core.exception
Generated by VariableHandler.
VariableHandlerException(DecodeEngine, Throwable, Object, Object, Field) - Constructor for exception cookxml.core.exception.VariableHandlerException
 
varLookup - Variable in exception cookxml.core.exception.VarLookupException
 
VarLookup - Interface in cookxml.core.interfaces
This is a general interface for getting/setting object variables
VarLookupException - Exception in cookxml.core.exception
 
VarLookupException(DecodeEngine, Throwable, VarLookup, String, Object, boolean) - Constructor for exception cookxml.core.exception.VarLookupException
 
VARREF_ATTR - Static variable in class cookxml.cookxml.CookXmlLib
read access to the variable
VARREF_PREFIX - Static variable in class cookxml.core.converter.ObjectConverter
 
A B C D E F G H I L M N O P R S T U V