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

Quick Search    Search Deep

  org.cantaloop.cgimlet.handler.* (1)
org.cantaloop.cgimlet.lang.* (25)org.cantaloop.cgimlet.lang.java.* (10)
org.cantaloop.cgimlet.testing.* (4)

org.cantaloop.cgimlet: Javadoc index of package org.cantaloop.cgimlet.


Package Samples:

org.cantaloop.cgimlet.handler
org.cantaloop.cgimlet.lang.java
org.cantaloop.cgimlet.lang
org.cantaloop.cgimlet.testing

Classes:

PropertyParser: A PropertyParser reads property-definitions and replaces their occurences in a XML file. A property is defined like this: <property name="basedir" value="."/> This sets the property `basedir' to the value `.'. From this point on the value of the property can be accessed in all attributes and all text-only elements by writing ${basedir} . It is an error to use a property that is not defined or to define a property a second time. A property can also be composed of existing properties. <property name="dir.src" value="${basedir}/src"> You can costomize the PropertyParser by setting the ...
OptionReader: Handlers can use a OptionReader to read configuration options. A options is a element which has a key and a value attribute, for example: <option name="input-dir" value="src"/> . By default, options are stored in a Options instance. To customize this behaviour you can use a OptionSetter , which is invoked every time a option is read. For a example of how to use an OptionReader have a look at the documentation of Options .
Options: Allows a handler the store options. Options can be grouped hierarchically by providing default values. Example: <foo> <option name="input-dir" value="${input}/src"/> <option name="output-dir" value="${output}/build"/> <bar> <option name="input-dir" value="${input}/src/foo"/> </bar> <foo> This options can be read as following: Element foo = root.element("foo"); Element bar = foo.element("bar"); OptionReaderConfigurator config = new OptionReaderConfigurator(MY_NAMESPACE); OptionReader fooReader = new OptionReader(config, foo, fooOpt); OptionReader barReader ...
Main: Entry point of the code generation when starting it from the command line. This class can also be used to invoke the codegeneration from within another program. Just set the project file with setProjectFile(File) 55 , configure the codegeneration with the setXXX methods and call ProjectRunner.run() 55 .
ProjectRunner: This class should be used to run a codegeneration process. The commandline entry point ( Main ) and the ant task ( ProjectGeneratorTask ) are based on this class.
MemberClassTemplate: A MemberClassTemplate is used to describe a member class of a another class. The MemberClassTemplate is not part of the template API in org.cantaloop.cgimlet.lang , so you only use it if you are absolutely shure that you want to generate code only for the java programming language.
OptionSetter: A OptionSetter instance can be attached to a OptionReader to control to way how options are processed.
Type: This class represents the type of a certain variable. For languages without a typesystem it is quite useless and can be ignored as long as you don't want the generate code for several programming languages.
ProjectGeneratorTask: Ant task for cgimlet. For a example on how to use the task, please have a look at the templates in the doc directory of the distribution.
JLanguageFactory: Implementation of org.cantaloop.cgimlet.lang.LanguageFactory for the java programming language.
OptionReaderConfigurator: You can use this class to adapt a OptionReader to your needs.
Modifier: Abstract representation of a modifier of a class, a field or a method. A modifier defines things like visibility for such a programming language construct.
ComponentHandler: Every class that wants the acts as a handler defined in the <handlerdef/> element of the project file must implement this interface.
AbstractModifier: Skeleton implementation of Modifier .
CodeCompiler: Defines the interface of a compiler or interpreter. Implementations of this class may be used to check the validity of the generated code.
JavaClassWriter: A org.cantaloop.cgimlet.lang.CodeWriter for the java programming language.
ProjectGenerator: A ProjectGenerator is attached to every projectfile. It configures the handlers and calls them to generate their code.
IDManager: The IDManager helps you to avaid naming-conflicts in your generated code. Just append the next id to your identifiers.
CGUtils: Interface that defines helper methods for generating common expression and statements in a programming language independent way.
CompileException: This exception is thrown if a CodeCompiler aborts the compilation due to an error or exits with an error code.
LanguageFactory: Factory class that creates the implementations of the interfaces in this package for a concrete programming language.
ClassTemplate: This interface defines the requirements from which a class (or a similar top-level construct) can be generated.
CodeGenerationException: This exception is thrown when an unrecoverable exception occurs during the codegeneration.
Assertions: This class defines some useful methods to ensure that a certain conditions holds true.

Home | Contact Us | Privacy Policy | Terms of Service