Class JStaticJavaFile

java.lang.Object

com.sun.codemodel.JResourceFile

com.sun.codemodel.fmt.JStaticJavaFile

public final class JStaticJavaFile
extends JResourceFile

Statically generated Java soruce file.

This JResourceFile implementation will generate a Java source file by copying the source code from a resource.

While copying a resource, we look for a package declaration and replace it with the target package name. This allows the static Java source code to have an arbitrary package declaration.

You can also use the getJClass method to obtain a JClass object that represents the static file. This allows the client code to refer to the class from other CodeModel generated code.

Note that because we don't parse the static Java source code, the returned JClass object doesn't respond to methods like "isInterface" or "_extends",

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JStaticJavaFile.ChainFilter	A JStaticJavaFile.LineFilter that combines two JStaticJavaFile.LineFilters.
private class	JStaticJavaFile.JStaticClass
static interface	JStaticJavaFile.LineFilter	Filter that alters the Java source code.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	className
private final JStaticJavaFile.JStaticClass	clazz
private final JStaticJavaFile.LineFilter	filter
private final JPackage	pkg
private final URL	source

Constructor Summary

Constructors

Constructor	Description
JStaticJavaFile(JPackage _pkg, String className, String _resourceName)
JStaticJavaFile(JPackage _pkg, String _className, URL _source, JStaticJavaFile.LineFilter _filter)

Method Summary

Modifier and Type	Method	Description
protected void	build(OutputStream os)	called by JPackage to produce the file image.
private JStaticJavaFile.LineFilter	createLineFilter()	Creates a JStaticJavaFile.LineFilter.
final JClass	getJClass()	Returns a class object that represents a statically generated code.
protected boolean	isResource()	Returns true if this file should be generated into the directory that the resource files go into.

Methods inherited from class JResourceFile

name

Methods inherited from class Object

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

Field Details

pkg

private final JPackage pkg

className

private final String className

source

private final URL source

clazz

private final JStaticJavaFile.JStaticClass clazz

filter

private final JStaticJavaFile.LineFilter filter

Constructor Details

JStaticJavaFile

public JStaticJavaFile(JPackage _pkg,
 String className,
 String _resourceName)

JStaticJavaFile

public JStaticJavaFile(JPackage _pkg,
 String _className,
 URL _source,
 JStaticJavaFile.LineFilter _filter)

Method Details

getJClass

public final JClass getJClass()

Returns a class object that represents a statically generated code.

isResource

protected boolean isResource()

Description copied from class: JResourceFile

Returns true if this file should be generated into the directory that the resource files go into.

Returns false if this file should be generated into the directory where other source files go.

Overrides:

isResource in class JResourceFile

build

protected void build(OutputStream os)
              throws IOException

Description copied from class: JResourceFile

called by JPackage to produce the file image.

Specified by:

build in class JResourceFile

Throws:

IOException

createLineFilter

private JStaticJavaFile.LineFilter createLineFilter()

Creates a JStaticJavaFile.LineFilter.

A derived class can override this method to process the contents of the source file.