Javadox

• Java Articles
• Maven Dependency

com.sun.codemodel
Class JCodeModel

java.lang.Object  com.sun.codemodel.JCodeModel

public final class JCodeModel

extends Object

Root of the code DOM.

Here's your typical CodeModel application.

 JCodeModel cm = new JCodeModel(); // generate source code by populating the 'cm' tree. cm._class(...); ... // write them out cm.build(new File(".")); 

Every CodeModel node is always owned by one JCodeModel object at any given time (which can be often accesesd by the owner() method.) As such, when you generate Java code, most of the operation works in a top-down fashion. For example, you create a class from JCodeModel, which gives you a JDefinedClass. Then you invoke a method on it to generate a new method, which gives you JMethod, and so on. There are a few exceptions to this, most notably building JExpressions, but generally you work with CodeModel in a top-down fashion. Because of this design, most of the CodeModel classes aren't directly instanciable.

Where to go from here?

Most of the time you'd want to populate new type definitions in a JCodeModel. See _class(String, ClassType).

Field Summary

JPrimitiveType	BOOLEAN
static Map<Class<?>,Class<?>>	boxToPrimitive The reverse look up for primitiveToBox
JPrimitiveType	BYTE
JPrimitiveType	CHAR
JPrimitiveType	DOUBLE
JPrimitiveType	FLOAT
JPrimitiveType	INT
protected static boolean	isCaseSensitiveFileSystem If the flag is true, we will consider two classes "Foo" and "foo" as a collision.
JPrimitiveType	LONG
JNullType	NULL Obtains a reference to the special "null" type.
static Map<Class<?>,Class<?>>	primitiveToBox Conversion from primitive type Class (such as Integer.TYPE to its boxed type (such as Integer.class)
JPrimitiveType	SHORT
JPrimitiveType	VOID

Constructor Summary

JCodeModel()

Method Summary

JDefinedClass	_class(int mods, String fullyqualifiedName, ClassType t) Creates a new generated class.
JDefinedClass	_class(String fullyqualifiedName) Creates a new generated class.
JDefinedClass	_class(String fullyqualifiedName, ClassType t) Creates a new generated class.
JDefinedClass	_getClass(String fullyQualifiedName) Gets a reference to the already created generated class.
JPackage	_package(String name) Add a package to the list of packages to be generated
JType	_ref(Class<?> c)
JDefinedClass	anonymousClass(Class<?> baseType)
JDefinedClass	anonymousClass(JClass baseType) Creates a new anonymous class.
void	build(CodeWriter out) A convenience method for build(out,out).
void	build(CodeWriter source, CodeWriter resource) Generates Java source code.
void	build(File destDir) A convenience method for build(destDir,System.out).
void	build(File srcDir, File resourceDir) A convenience method for build(srcDir,resourceDir,System.out).
void	build(File srcDir, File resourceDir, PrintStream status) Generates Java source code.
void	build(File destDir, PrintStream status) Generates Java source code.
int	countArtifacts() Returns the number of files to be generated if build(java.io.File, java.io.PrintStream) is invoked now.
JClass	directClass(String name) Creates a dummy, unknown JClass that represents a given name.
JDefinedClass	newAnonymousClass(JClass baseType) Deprecated. The naming convention doesn't match the rest of the CodeModel. Use anonymousClass(JClass) instead.
Iterator<JPackage>	packages() Returns an iterator that walks the packages defined using this code writer.
JType	parseType(String name) Obtains a type object from a type name.
JClass	ref(Class<?> clazz) Obtains a reference to an existing class from its Class object.
JClass	ref(String fullyQualifiedClassName) Obtains a reference to an existing class from its fully-qualified class name.
JPackage	rootPackage()
JClass	wildcard() Gets a JClass representation for "?", which is equivalent to "? extends Object".

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public final JNullType NULL

Obtains a reference to the special "null" type.

VOID

public final JPrimitiveType VOID

BOOLEAN

public final JPrimitiveType BOOLEAN

BYTE

public final JPrimitiveType BYTE

SHORT

public final JPrimitiveType SHORT

CHAR

public final JPrimitiveType CHAR

INT

public final JPrimitiveType INT

FLOAT

public final JPrimitiveType FLOAT

LONG

public final JPrimitiveType LONG

DOUBLE

public final JPrimitiveType DOUBLE

isCaseSensitiveFileSystem

protected static final boolean isCaseSensitiveFileSystem

If the flag is true, we will consider two classes "Foo" and "foo" as a collision.

primitiveToBox

public static final Map<Class<?>,Class<?>> primitiveToBox

Conversion from primitive type Class (such as Integer.TYPE to its boxed type (such as Integer.class)

boxToPrimitive

public static final Map<Class<?>,Class<?>> boxToPrimitive

The reverse look up for primitiveToBox

Constructor Detail

JCodeModel

public JCodeModel()

Method Detail

_package

public JPackage _package(String name)

Add a package to the list of packages to be generated

Parameters:

name - Name of the package. Use "" to indicate the root package.

Returns:

Newly generated package

rootPackage

public final JPackage rootPackage()

packages

public Iterator<JPackage> packages()

Returns an iterator that walks the packages defined using this code writer.

_class

public JDefinedClass _class(String fullyqualifiedName)                     throws JClassAlreadyExistsException

Creates a new generated class.

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

directClass

public JClass directClass(String name)

Creates a dummy, unknown JClass that represents a given name.

This method is useful when the code generation needs to include the user-specified class that may or may not exist, and only thing known about it is a class name.

_class

public JDefinedClass _class(int mods,                            String fullyqualifiedName,                            ClassType t)                     throws JClassAlreadyExistsException

Creates a new generated class.

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

_class

public JDefinedClass _class(String fullyqualifiedName,                            ClassType t)                     throws JClassAlreadyExistsException

Creates a new generated class.

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

_getClass

public JDefinedClass _getClass(String fullyQualifiedName)

Gets a reference to the already created generated class.

Returns:

null If the class is not yet created.

See Also:

JPackage._getClass(String)

newAnonymousClass

public JDefinedClass newAnonymousClass(JClass baseType)

Deprecated. The naming convention doesn't match the rest of the CodeModel. Use anonymousClass(JClass) instead.

Creates a new anonymous class.

anonymousClass

public JDefinedClass anonymousClass(JClass baseType)

Creates a new anonymous class.

anonymousClass

public JDefinedClass anonymousClass(Class<?> baseType)

build

public void build(File destDir,                  PrintStream status)           throws IOException

Generates Java source code. A convenience method for build(destDir,destDir,System.out).

Parameters:

destDir - source files are generated into this directory.

status - if non-null, progress indication will be sent to this stream.

Throws:

IOException

build

public void build(File srcDir,                  File resourceDir,                  PrintStream status)           throws IOException

Generates Java source code. A convenience method that calls build(CodeWriter,CodeWriter).

Parameters:

srcDir - Java source files are generated into this directory.

resourceDir - Other resource files are generated into this directory.

status - if non-null, progress indication will be sent to this stream.

Throws:

IOException

build

public void build(File destDir)           throws IOException

A convenience method for build(destDir,System.out).

Throws:

IOException

build

public void build(File srcDir,                  File resourceDir)           throws IOException

A convenience method for build(srcDir,resourceDir,System.out).

Throws:

IOException

build

public void build(CodeWriter out)           throws IOException

A convenience method for build(out,out).

Throws:

IOException

build

public void build(CodeWriter source,                  CodeWriter resource)           throws IOException

Generates Java source code.

Throws:

IOException

countArtifacts

public int countArtifacts()

Returns the number of files to be generated if build(java.io.File, java.io.PrintStream) is invoked now.

ref

public JClass ref(Class<?> clazz)

Obtains a reference to an existing class from its Class object.

The parameter may not be primitive.

See Also:

for the version that handles more cases.

_ref

public JType _ref(Class<?> c)

ref

public JClass ref(String fullyQualifiedClassName)

Obtains a reference to an existing class from its fully-qualified class name.

First, this method attempts to load the class of the given name. If that fails, we assume that the class is derived straight from Object, and return a JClass.

wildcard

public JClass wildcard()

Gets a JClass representation for "?", which is equivalent to "? extends Object".

parseType

public JType parseType(String name)                throws ClassNotFoundException

Obtains a type object from a type name.

This method handles primitive types, arrays, and existing Classes.

Throws:

ClassNotFoundException - If the specified type is not found.