com.sun.codemodel.package-info Maven / Gradle / Ivy
/**
* Library for generating Java source code
.
*
*
* CodeModel is a library that allows you to generate Java source
* code in a type-safe fashion.
*
*
* With CodeModel, you build the java source code by first building AST,
* then writing it out as text files that is Java source files.
* The AST looks like this:
*
* {@DotDiagram
digraph G {
cls1 [label="JDefinedClass"];
cls2 [label="JDefinedClass"];
JCodeModel -> cls1 [label="generated class"];
JCodeModel -> cls2 [label="generated class"];
m1 [label="JMethod"];
m2 [label="JMethod"];
cls1 -> m1;
cls1 -> m2;
cls1 -> JField;
m1 -> JVar [label="method parameter"];
m1 -> JBlock [label="code"];
}
* }
*
*
* You bulid this tree mostly from top-down. So, you first create
* a new {@link JDefinedClass} from {@link JCodeModel}, then you
* create a {@link JMethod} from {@link JDefinedClass}, and so on.
*
*
* This design brings the following beneefits:
*
*
* - source code can be written in random order
*
- generated source code nicely imports other classes
*
- generated source code is lexically always correct
* (no unbalanced parenthesis, etc.)
*
- code generation becomes relatively type-safe
*
*
* The price you pay for that is
* increased memory footprint and the generation speed.
* See performance section for
* more discussions about the performance and possible improvements.
*
*
* Using CodeModel
*
* {@link com.sun.codemodel.JCodeModel} is the entry point to
* the library. See its javadoc for more details about how to use
* CodeModel.
*
*
*
*
Performance
*
* Generally speaking, CodeModel is expected to be used in
* an environment where the resource constraint is not severe.
* Therefore, we haven't spent much effort in trying to make
* this library lean and mean.
*
*
* That said, we did some benchmark and performance analysis.
* In case anyone is interested in making this library
* better performance wise, here's the findings.
*
*
* {@link List}s {@link Map}s, and other collections take up
* a lot of space. Allocating those things lazily is generally
* a good idea.
*
*
* Compared to template-based code generator, the writing operation
* is slow, as it needs to traverse each AST node. Consider
* pre-encoding tokens (like 'public') to the target encoding,
* and consider exploting the subtree equivalence.
*
* @ArchitectureDocument
*/
package com.sun.codemodel;
import java.util.List;
import java.util.Map;