|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tools.ant.ProjectComponent org.apache.tools.ant.Task org.apache.tools.ant.taskdefs.MatchingTask org.apache.tools.ant.taskdefs.optional.jsp.JspC
public class JspC
Runs a JSP compiler.
This task takes the given jsp files and compiles them into java files. It is then up to the user to compile the java files into classes.
The task requires the srcdir and destdir attributes to be set. This Task is a MatchingTask, so the files to be compiled can be specified using includes/excludes attributes or nested include/exclude elements. Optional attributes are verbose (set the verbosity level passed to jasper), package (name of the destination package for generated java classes and classpath (the classpath to use when running the jsp compiler).
This task supports the nested elements classpath (A Path) and classpathref (A Reference) which can be used in preference to the attribute classpath, if the jsp compiler is not already in the ant classpath.
<jspc srcdir="${basedir}/src/war" destdir="${basedir}/gensrc" package="com.i3sp.jsp" verbose="9"> <include name="**\/*.jsp" /> </jspc>
Large Amount of cutting and pasting from the Javac task...
Nested Class Summary | |
---|---|
static class |
JspC.WebAppParameter
static inner class used as a parameter element |
Field Summary | |
---|---|
protected java.util.Vector |
compileList
|
protected boolean |
failOnError
flag to control action on execution trouble |
protected JspC.WebAppParameter |
webApp
web apps |
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
---|
fileset |
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
JspC()
|
Method Summary | |
---|---|
void |
addWebApp(JspC.WebAppParameter webappParam)
Adds a single webapp. |
Path |
createClasspath()
Adds a path to the classpath. |
Path |
createCompilerclasspath()
Support nested compiler classpath, used to locate compiler adapter |
void |
deleteEmptyJavaFiles()
delete any java output files that are empty this is to get around a little defect in jasper: when it fails, it leaves incomplete files around. |
void |
execute()
execute by building up a list of files that have changed and hand them off to a jsp compiler |
Path |
getClasspath()
Get the classpath. |
java.util.Vector |
getCompileList()
get the list of files to compile |
Path |
getCompilerclasspath()
get the classpath used to find the compiler adapter |
java.io.File |
getDestdir()
Get the destination directory. |
boolean |
getFailonerror()
Gets the failonerror flag. |
java.lang.String |
getIeplugin()
Get the IE CLASSID value. |
java.lang.String |
getPackage()
Get the name of the package. |
Path |
getSrcDir()
Get the source dir. |
java.io.File |
getUribase()
Get the uri base value. |
java.io.File |
getUriroot()
Get the uri root value. |
int |
getVerbose()
Get the verbose level. |
JspC.WebAppParameter |
getWebApp()
Get the web app. |
java.io.File |
getWebinc()
Get the webinc attribute. |
java.io.File |
getWebxml()
Filename for web.xml. |
boolean |
isMapped()
If true, generate separate write() calls for each HTML line in the JSP. |
protected java.io.File |
mapToJavaFile(JspMangler mangler,
java.io.File srcFile,
java.io.File srcDir,
java.io.File dest)
get a filename from our jsp file. |
protected void |
resetFileLists()
Clear the list of files to be compiled and copied.. |
protected void |
scanDir(java.io.File srcDir,
java.io.File dest,
JspMangler mangler,
java.lang.String[] files)
Scans the directory looking for source files to be compiled. |
void |
setClasspath(Path cp)
Set the classpath to be used for this compilation. |
void |
setClasspathRef(Reference r)
Adds a reference to a classpath defined elsewhere |
void |
setCompiler(java.lang.String compiler)
Class name of a JSP compiler adapter. |
void |
setCompilerclasspath(Path cp)
Set the classpath to be used to find this compiler adapter |
void |
setDestdir(java.io.File destDir)
Set the destination directory into which the JSP source files should be compiled. |
void |
setFailonerror(boolean fail)
Whether or not the build should halt if compilation fails. |
void |
setIeplugin(java.lang.String iepluginid)
Java Plugin CLASSID for Internet Explorer |
void |
setMapped(boolean mapped)
If true, generate separate write() calls for each HTML line in the JSP. |
void |
setPackage(java.lang.String pkg)
Set the name of the package the compiled jsp files should be in. |
void |
setSrcDir(Path srcDir)
Set the path for source JSP files. |
void |
setUribase(java.io.File uribase)
The URI context of relative URI references in the JSP pages. |
void |
setUriroot(java.io.File uriroot)
The root directory that uri files should be resolved against. |
void |
setVerbose(int i)
Set the verbose level of the compiler |
void |
setWebinc(java.io.File webinc)
output filename for the fraction of web.xml that lists servlets. |
void |
setWebxml(java.io.File webxml)
Filename for web.xml. |
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
---|
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.Vector compileList
protected boolean failOnError
protected JspC.WebAppParameter webApp
Constructor Detail |
---|
public JspC()
Method Detail |
---|
public void setSrcDir(Path srcDir)
srcDir
- the source path.public Path getSrcDir()
public void setDestdir(java.io.File destDir)
destDir
- the destination directory.public java.io.File getDestdir()
public void setPackage(java.lang.String pkg)
pkg
- the name of the package.public java.lang.String getPackage()
public void setVerbose(int i)
i
- the verbose level to use.public int getVerbose()
public void setFailonerror(boolean fail)
true
.
fail
- a boolean
value.public boolean getFailonerror()
public java.lang.String getIeplugin()
public void setIeplugin(java.lang.String iepluginid)
iepluginid
- the id to use.public boolean isMapped()
public void setMapped(boolean mapped)
mapped
- a boolean
value.public void setUribase(java.io.File uribase)
uribase
- The new Uribase valuepublic java.io.File getUribase()
public void setUriroot(java.io.File uriroot)
uriroot
- The new Uribase valuepublic java.io.File getUriroot()
public void setClasspath(Path cp)
cp
- the path to be used.public Path createClasspath()
public void setClasspathRef(Reference r)
r
- a reference to a classpath.public Path getClasspath()
public void setCompilerclasspath(Path cp)
cp
- the compiler classpath.public Path getCompilerclasspath()
public Path createCompilerclasspath()
public void setWebxml(java.io.File webxml)
webxml
- The new Webxml valuepublic java.io.File getWebxml()
public void setWebinc(java.io.File webinc)
webinc
- The new Webinc valuepublic java.io.File getWebinc()
public void addWebApp(JspC.WebAppParameter webappParam) throws BuildException
webappParam
- add a web app parameter
BuildException
- if more than one webapp is specified.public JspC.WebAppParameter getWebApp()
public void setCompiler(java.lang.String compiler)
compiler
- the compiler class name.public java.util.Vector getCompileList()
public void execute() throws BuildException
execute
in class Task
BuildException
- on error.protected void resetFileLists()
protected void scanDir(java.io.File srcDir, java.io.File dest, JspMangler mangler, java.lang.String[] files)
srcDir
- the source directory.dest
- the destination directory.mangler
- the jsp filename mangler.files
- the file names to mangle.protected java.io.File mapToJavaFile(JspMangler mangler, java.io.File srcFile, java.io.File srcDir, java.io.File dest)
mangler
- the jsp filename managler.srcFile
- the source file.srcDir
- the source directory.dest
- the destination directory.
public void deleteEmptyJavaFiles()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |