Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
A C E G I K L M N O P R S T V X

A

Assertions - class org.cantaloop.cgimlet.Assertions.
This class defines some useful methods to ensure that a certain conditions holds true.
Assertions() - Constructor for class org.cantaloop.cgimlet.Assertions
 
adjustBaseDir(String) - Method in class org.cantaloop.cgimlet.ProjectGenerator
 
apply(Element) - Method in class org.cantaloop.cgimlet.PropertyParser
Shorthand for:
initProperties(root);
replaceProperties(root);
getProperties();
assertContains(Map, Object, String) - Static method in class org.cantaloop.cgimlet.Assertions
Checks if map contains the given key.
assertNotNull(Object, String) - Static method in class org.cantaloop.cgimlet.Assertions
Throws a CodeGenerationException with the given error message if obj == null.
assertTrue(boolean, String) - Static method in class org.cantaloop.cgimlet.Assertions
Throws a CodeGenerationException with the given error message if the boolean parameter condition is false.

C

CONFIGURE - Static variable in class org.cantaloop.cgimlet.ProjectGenerator
 
CodeGenerationException - exception org.cantaloop.cgimlet.CodeGenerationException.
This exception is thrown when an unrecoverable exception occurs during the codegeneration.
CodeGenerationException() - Constructor for class org.cantaloop.cgimlet.CodeGenerationException
 
CodeGenerationException(String) - Constructor for class org.cantaloop.cgimlet.CodeGenerationException
Creates a new CodeGenerationException instance.
CodeGenerationException(String, Throwable) - Constructor for class org.cantaloop.cgimlet.CodeGenerationException
Creates a new CodeGenerationException instance.
ComponentHandler - interface org.cantaloop.cgimlet.ComponentHandler.
Every class that wants the acts as a handler defined in the <handlerdef/> element of the project file must implement this interface.
Constants - interface org.cantaloop.cgimlet.Constants.
Useful constants.
callHandler(Element, String) - Method in class org.cantaloop.cgimlet.ProjectGenerator
 
compareFilenames(String, String) - Method in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
configure(Element) - Method in interface org.cantaloop.cgimlet.ComponentHandler
Request the handler to configure itself with the given configuration element.
containsKey(Object) - Method in class org.cantaloop.cgimlet.Options
Overwritten to ask the default instance of the key is not found in this instance.
containsValue(Object) - Method in class org.cantaloop.cgimlet.Options
Overwritten to ask the default instance of the key is not found in this instance.
currentID() - Method in class org.cantaloop.cgimlet.IDManager
Returns the current id.

E

elemName - Variable in class org.cantaloop.cgimlet.OptionReaderConfigurator
 
execute() - Method in class org.cantaloop.cgimlet.ProjectGeneratorTask
execute should be called only by ant.

G

GENERATE - Static variable in class org.cantaloop.cgimlet.ProjectGenerator
 
gen - Variable in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
generate(Element) - Method in interface org.cantaloop.cgimlet.ComponentHandler
Request the handler to generate the code.
get(Object) - Method in class org.cantaloop.cgimlet.Options
Overwritten to ask the default instance if the key is not found in this instance.
getBaseDir() - Method in class org.cantaloop.cgimlet.ProjectGenerator
Get the base directory of the project.
getCodeWriter(String, LanguageFactory) - Method in class org.cantaloop.cgimlet.ProjectGenerator
Returns a codewriter for the programming language lang that is configured with dirname as basedir.
getCopyright() - Static method in class org.cantaloop.cgimlet.ProjectRunner
Returns the copyright string.
getDefaults() - Method in class org.cantaloop.cgimlet.Options
Get the default values.
getElementName() - Method in class org.cantaloop.cgimlet.OptionReaderConfigurator
Get the QName of the elements that contains the options.
getHandler(String) - Method in class org.cantaloop.cgimlet.ProjectGenerator
Get the handler with key key.
getHandlerKey(Class) - Method in class org.cantaloop.cgimlet.ProjectGenerator
Get the key that was used to register a handler of type handlerType.
getKeyAttributeName() - Method in class org.cantaloop.cgimlet.OptionReaderConfigurator
Get the name of the attribute that holds the key of the option
getLogger(Object) - Method in class org.cantaloop.cgimlet.ProjectGenerator
Get a logger for the given object that is preconfigured with the topic of the ProjectGenerator.
getLoggerTopic() - Method in class org.cantaloop.cgimlet.ProjectGenerator
Return the topic the ProjectGenerator is logging on.
getNestedException() - Method in class org.cantaloop.cgimlet.CodeGenerationException
Returns the exception that has caused the CodeGenerationException.
getOption(String) - Method in class org.cantaloop.cgimlet.OptionReader
Get the value of the option key.
getOption(String) - Method in class org.cantaloop.cgimlet.Options
Get the option with key key.
getOption(String, String) - Method in class org.cantaloop.cgimlet.Options
Get the option with key key.
getOptions() - Method in class org.cantaloop.cgimlet.OptionReader
Get the options instance the values are written to.
getProjectDocument() - Method in class org.cantaloop.cgimlet.ProjectGenerator
Get the document for the project file.
getProjectGenerator() - Static method in class org.cantaloop.cgimlet.ProjectRunner
Get the project generator of the last run.
getProperties() - Method in class org.cantaloop.cgimlet.ProjectGenerator
Get the properties of this project
getProperties() - Method in class org.cantaloop.cgimlet.PropertyParser
Returns the properties the parser has read.
getQName(String, Element) - Static method in class org.cantaloop.cgimlet.XMLUtils
Get the QName of a raw name.
getResultMap() - Method in class org.cantaloop.cgimlet.ProjectGenerator
Returns the results the handlers.
getRootElement() - Method in class org.cantaloop.cgimlet.OptionReader
Get the root element of this OptionReader.
getUsage() - Static method in class org.cantaloop.cgimlet.Main
Returns a string that contains information about how to use the codegeneration from the commandline.
getValueAttributeName() - Method in class org.cantaloop.cgimlet.OptionReaderConfigurator
Get the name of the attribute that holds the value of the option
getVersion() - Static method in class org.cantaloop.cgimlet.ProjectRunner
Returns the version string.

I

IDManager - class org.cantaloop.cgimlet.IDManager.
The IDManager helps you to avaid naming-conflicts in your generated code.
IDManager() - Constructor for class org.cantaloop.cgimlet.IDManager
 
InternalCodeGenerationException - exception org.cantaloop.cgimlet.InternalCodeGenerationException.
This exception is thrown when a bug is detected at runtime.
InternalCodeGenerationException() - Constructor for class org.cantaloop.cgimlet.InternalCodeGenerationException
 
InternalCodeGenerationException(String) - Constructor for class org.cantaloop.cgimlet.InternalCodeGenerationException
 
init(ProjectGenerator) - Method in interface org.cantaloop.cgimlet.ComponentHandler
Initialize the handler.
initHandlers(Element) - Method in class org.cantaloop.cgimlet.ProjectGenerator
 
initProperties(Element) - Method in class org.cantaloop.cgimlet.PropertyParser
Read the properties from the elements that are direct children of root.

K

keyAttr - Variable in class org.cantaloop.cgimlet.OptionReaderConfigurator
 

L

LOGGER_TOPIC_PREFIX - Static variable in interface org.cantaloop.cgimlet.Constants
The prefix for all logging activity.
LOG_DEFAULT - Static variable in class org.cantaloop.cgimlet.ProjectGenerator
Constant used with ProjectGenerator.setLogLevel(int) 55 .
LOG_QUIET - Static variable in class org.cantaloop.cgimlet.ProjectGenerator
Constant used with ProjectGenerator.setLogLevel(int) 55 .
LOG_VERBOSE - Static variable in class org.cantaloop.cgimlet.ProjectGenerator
Constant used with ProjectGenerator.setLogLevel(int) 55 .

M

Main - class org.cantaloop.cgimlet.Main.
Entry point of the code generation when starting it from the command line.
Main() - Constructor for class org.cantaloop.cgimlet.Main
 
m_baseDir - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_config - Variable in class org.cantaloop.cgimlet.OptionReader
 
m_currentID - Variable in class org.cantaloop.cgimlet.IDManager
 
m_debug - Variable in class org.cantaloop.cgimlet.ProjectRunner
 
m_defaults - Variable in class org.cantaloop.cgimlet.Options
 
m_doc - Variable in class org.cantaloop.cgimlet.ProjectGenerator
the project document.
m_elemName - Variable in class org.cantaloop.cgimlet.PropertyParser
 
m_handlerKeyMap - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_handlerMap - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_keyAttr - Variable in class org.cantaloop.cgimlet.PropertyParser
 
m_level - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_log - Variable in class org.cantaloop.cgimlet.OptionReader
 
m_log - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_loggerTopic - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_loggingManager - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_opt - Variable in class org.cantaloop.cgimlet.OptionReader
 
m_parser - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_prettyPrinting - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_prettyPrinting - Variable in class org.cantaloop.cgimlet.ProjectRunner
 
m_prjFile - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_prjFile - Variable in class org.cantaloop.cgimlet.ProjectRunner
 
m_props - Variable in class org.cantaloop.cgimlet.PropertyParser
 
m_quiet - Variable in class org.cantaloop.cgimlet.ProjectRunner
 
m_resultMap - Variable in class org.cantaloop.cgimlet.ProjectGenerator
 
m_root - Variable in class org.cantaloop.cgimlet.OptionReader
 
m_runner - Variable in class org.cantaloop.cgimlet.ProjectGeneratorTask
 
m_setter - Variable in class org.cantaloop.cgimlet.OptionReader
 
m_valueAttr - Variable in class org.cantaloop.cgimlet.PropertyParser
 
m_verbose - Variable in class org.cantaloop.cgimlet.ProjectRunner
 
main(String[]) - Static method in class org.cantaloop.cgimlet.Main
This method is called when starting the codegeneration from the commandline by the VM, passing the commandline arguments as parameter.

N

namespacedElements(Element, Namespace) - Static method in class org.cantaloop.cgimlet.XMLUtils
Get a list with the direct children of parent that are in namespace ns.
nestedException - Variable in class org.cantaloop.cgimlet.CodeGenerationException
 
nextID() - Method in class org.cantaloop.cgimlet.IDManager
Sets the id to its next value and returns it.

O

OptionReader - class org.cantaloop.cgimlet.OptionReader.
Handlers can use a OptionReader to read configuration options.
OptionReader(OptionReaderConfigurator, Element) - Constructor for class org.cantaloop.cgimlet.OptionReader
Creates a new OptionReader instance.
OptionReader(OptionReaderConfigurator, Options) - Constructor for class org.cantaloop.cgimlet.OptionReader
Creates a new OptionReader instance.
OptionReader(OptionReaderConfigurator, Element, Options) - Constructor for class org.cantaloop.cgimlet.OptionReader
Creates a new OptionReader instance.
OptionReaderConfigurator - class org.cantaloop.cgimlet.OptionReaderConfigurator.
You can use this class to adapt a OptionReader to your needs.
OptionReaderConfigurator(Namespace) - Constructor for class org.cantaloop.cgimlet.OptionReaderConfigurator
Shorthand for OptionReaderConfigurator(new QName("option", ns)).
OptionReaderConfigurator(QName) - Constructor for class org.cantaloop.cgimlet.OptionReaderConfigurator
Shorthand for OptionReaderConfigurator(elemName, "name", "value").
OptionReaderConfigurator(QName, String, String) - Constructor for class org.cantaloop.cgimlet.OptionReaderConfigurator
Creates a new OptionReaderConfigurator instance.
OptionSetter - interface org.cantaloop.cgimlet.OptionSetter.
A OptionSetter instance can be attached to a OptionReader to control to way how options are processed.
Options - class org.cantaloop.cgimlet.Options.
Allows a handler the store options.
Options() - Constructor for class org.cantaloop.cgimlet.Options
Creates a new Options instance without default values.
Options(Options) - Constructor for class org.cantaloop.cgimlet.Options
Creates a new Options instance with the default values found in def
org.cantaloop.cgimlet - package org.cantaloop.cgimlet
 

P

PROJECT_NS - Static variable in interface org.cantaloop.cgimlet.Constants
The namespace for the projectfile.
PROJECT_NS_URI - Static variable in interface org.cantaloop.cgimlet.Constants
The URI of the namespace for the projectfile.
PROPERTY - Static variable in interface org.cantaloop.cgimlet.Constants
The name of the element in the projectfile that defines properties.
ProjectGenerator - class org.cantaloop.cgimlet.ProjectGenerator.
A ProjectGenerator is attached to every projectfile.
ProjectGenerator(File) - Constructor for class org.cantaloop.cgimlet.ProjectGenerator
 
ProjectGeneratorTask - class org.cantaloop.cgimlet.ProjectGeneratorTask.
Ant task for cgimlet.
ProjectGeneratorTask() - Constructor for class org.cantaloop.cgimlet.ProjectGeneratorTask
 
ProjectGeneratorUTest - class org.cantaloop.cgimlet.ProjectGeneratorUTest.
This class is for testing purpose only.
ProjectGeneratorUTest(String) - Constructor for class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
ProjectRunner - class org.cantaloop.cgimlet.ProjectRunner.
This class should be used to run a codegeneration process.
ProjectRunner() - Constructor for class org.cantaloop.cgimlet.ProjectRunner
 
PropertyParser - class org.cantaloop.cgimlet.PropertyParser.
A PropertyParser reads property-definitions and replaces their occurences in a XML file.
PropertyParser(Namespace) - Constructor for class org.cantaloop.cgimlet.PropertyParser
Shorthand for:
PropertyParser(new QName("property", ns)).
PropertyParser(QName) - Constructor for class org.cantaloop.cgimlet.PropertyParser
Shorthand for:
PropertyParser(elemName, "name", "value").
PropertyParser(QName, String, String) - Constructor for class org.cantaloop.cgimlet.PropertyParser
Creates a new customized PropertyParser instance.
parse(Element) - Method in class org.cantaloop.cgimlet.PropertyParser
Deprecated. use PropertyParser.apply(org.dom4j.Element) 55 instead.
parse(File) - Static method in class org.cantaloop.cgimlet.XMLUtils
Parse the file f and return the xml document.
parse(InputStream) - Static method in class org.cantaloop.cgimlet.XMLUtils
Parse the input stream and return the xml document.
parsePropertyString(String) - Method in class org.cantaloop.cgimlet.PropertyParser
Parse value and resolve all properties in the given string.
Throws a CodeGenerationException if a property cannot be resolved.
parsePropertyString(String, List, List) - Static method in class org.cantaloop.cgimlet.PropertyParser
Taken from ant (www.jakarta.apache.org/ant) This method will parse a string containing ${value} style property values into two lists.
prjFile - Variable in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 

R

read() - Method in class org.cantaloop.cgimlet.OptionReader
Read the options of the root element of this reader.
read(Element) - Method in class org.cantaloop.cgimlet.OptionReader
Read the options of root.
registerHandler(String, ComponentHandler) - Method in class org.cantaloop.cgimlet.ProjectGenerator
Register a handler.
replaceProperties(Element) - Method in class org.cantaloop.cgimlet.PropertyParser
Replace all properties in the xml tree starting with element root.
resolveFilename(String) - Method in class org.cantaloop.cgimlet.ProjectGenerator
Resolves the abstract pathname name against the base directory of the project.
run() - Method in class org.cantaloop.cgimlet.ProjectGenerator
Run the codegeneration.
run() - Method in class org.cantaloop.cgimlet.ProjectRunner
Run the code generation process.
runAndCatch() - Method in class org.cantaloop.cgimlet.ProjectRunner
Run the code codegeneration process, catch all exceptions and dipslay a error message (if necessary).

S

s_gen - Static variable in class org.cantaloop.cgimlet.ProjectRunner
 
sep - Variable in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
setDebug(boolean) - Method in class org.cantaloop.cgimlet.ProjectGenerator
 
setDebug(boolean) - Method in class org.cantaloop.cgimlet.ProjectGeneratorTask
Enables debugging output.
setDebug(boolean) - Method in class org.cantaloop.cgimlet.ProjectRunner
Enables debugging output.
setDefaults(Options) - Method in class org.cantaloop.cgimlet.Options
Set the default values that should be used.
setLogLevel(int) - Method in class org.cantaloop.cgimlet.ProjectGenerator
Set the log level of the ProjectGenerator.
setOption(String, String) - Method in class org.cantaloop.cgimlet.OptionReader
Set option key to value.
setOption(String, String) - Method in interface org.cantaloop.cgimlet.OptionSetter
Invoked every time a option is read.
setOption(String, String) - Method in class org.cantaloop.cgimlet.Options
Convenient method.
setOptionSetter(OptionSetter) - Method in class org.cantaloop.cgimlet.OptionReader
Set a handler which is called whenever a option has been read.
setOptions(Options) - Method in class org.cantaloop.cgimlet.OptionReader
Set the options instance the values are written to.
setPrettyPrinting(boolean) - Method in class org.cantaloop.cgimlet.ProjectGenerator
 
setPrettyPrinting(boolean) - Method in class org.cantaloop.cgimlet.ProjectGeneratorTask
Set if the generated files should be pretty printed.
setPrettyPrinting(boolean) - Method in class org.cantaloop.cgimlet.ProjectRunner
Set if the generated files should be pretty printed.
setProjectFile(File) - Method in class org.cantaloop.cgimlet.Main
Set the project file.
setProjectFile(String) - Method in class org.cantaloop.cgimlet.ProjectGeneratorTask
Set the project file as a string.
setProjectFile(String) - Method in class org.cantaloop.cgimlet.ProjectRunner
Set the project file as a string.
setQuiet(boolean) - Method in class org.cantaloop.cgimlet.ProjectGeneratorTask
Set if the codegeneration should be extra quiet.
setQuiet(boolean) - Method in class org.cantaloop.cgimlet.ProjectRunner
Set if the codegeneration should be extra quiet.
setRootElement(Element) - Method in class org.cantaloop.cgimlet.OptionReader
Set the element that should be used as the root element.
setUp() - Method in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
setVerbose(boolean) - Method in class org.cantaloop.cgimlet.ProjectGeneratorTask
Set if the codegeneration should be verbose.
setVerbose(boolean) - Method in class org.cantaloop.cgimlet.ProjectRunner
Set if the codegeneration should be verbose.

T

testGenerate() - Method in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
testHandlers() - Method in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
testInit() - Method in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
testOptions() - Method in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
toString() - Method in class org.cantaloop.cgimlet.CodeGenerationException
Returns a string representation of the exception, including the error message of the nested exception (if available).

V

vBaseDir - Variable in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
vInput - Variable in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
vOutput - Variable in class org.cantaloop.cgimlet.ProjectGeneratorUTest
 
valueAttr - Variable in class org.cantaloop.cgimlet.OptionReaderConfigurator
 

X

XMLUtils - class org.cantaloop.cgimlet.XMLUtils.
This class provides some useful methods that helps you with common XML tasks.
XMLUtils() - Constructor for class org.cantaloop.cgimlet.XMLUtils
 

A C E G I K L M N O P R S T V X