|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jasper.JspC
Shell for the jspc compiler. Handles all options associated with the command line and creates compilation contexts which it then compiles according to the specified options. This version can process files from a _single_ webapp at once, i.e. a single docbase can be specified. It can be used as an Ant task using:
<taskdef classname="org.apache.jasper.JspC" name="jasper2" > <classpath> <pathelement location="${java.home}/../lib/tools.jar"/> <fileset dir="${ENV.CATALINA_HOME}/server/lib"> <include name="*.jar"/> </fileset> <fileset dir="${ENV.CATALINA_HOME}/common/lib"> <include name="*.jar"/> </fileset> <path refid="myjars"/> </classpath> </taskdef> <jasper2 verbose="0" package="my.package" uriroot="${webapps.dir}/${webapp.name}" webXmlFragment="${build.dir}/generated_web.xml" outputDir="${webapp.dir}/${webapp.name}/WEB-INF/src/my/package" />
Field Summary | |
static java.lang.String |
DEFAULT_IE_CLASS_ID
The default Microsoft Internet Explorer class ID. |
Constructor Summary | |
JspC()
Constructor. |
Method Summary | |
protected void |
addExtension(java.lang.String extension)
Adds the given file extension to the list of extensions handled as JSP files. |
void |
execute()
Executes the compilation. |
void |
generateWebMapping(java.lang.String file,
JspCompilationContext clctxt)
|
boolean |
genStringAsCharArray()
Indicates whether text strings are to be generated as char arrays. |
java.util.Map |
getCache()
The web-application wide cache for the returned TreeNode by parseXMLDocument in TagLibraryInfoImpl.parseTLD, if isCaching returns true. |
int |
getCheckInterval()
Background compilation check intervals in seconds |
boolean |
getClassDebugInfo()
Should we include debug information in compiled class? |
java.lang.String |
getClassPath()
What classpath should I use while compiling the servlets generated from JSP files? |
java.lang.String |
getCompiler()
Compiler to use. |
java.lang.String |
getCompilerSourceVM()
Compiler source VM, e.g. 1.3, 1.4, or 1.5. |
java.lang.String |
getCompilerTargetVM()
The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, or 1.5. |
boolean |
getDevelopment()
Is Jasper being used in development mode? |
boolean |
getErrorOnUseBeanInvalidClassAttribute()
Returns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid. |
java.util.List |
getExtensions()
Returns the list of file extensions that are treated as JSP files. |
boolean |
getFailOnError()
|
boolean |
getFork()
boolean flag to tell Ant whether to fork JSP page compilations. |
java.lang.String |
getIeClassId()
Gets the class-id value that is sent to Internet Explorer when using |
java.lang.String |
getJavaEncoding()
Returns the encoding to use for java files. |
java.lang.String |
getJspCompilerPath()
|
java.lang.Class |
getJspCompilerPlugin()
|
JspConfig |
getJspConfig()
Obtain JSP configuration informantion specified in web.xml. |
boolean |
getKeepGenerated()
Are we keeping generated code around? |
boolean |
getMappedFile()
Are we supporting HTML mapped servlets? |
int |
getModificationTestInterval()
Modification test interval. |
org.apache.tools.ant.Project |
getProject()
Returns the project: may be null if not running inside an Ant project. |
java.lang.Object |
getProtectionDomain()
|
java.io.File |
getScratchDir()
What is my scratch dir? |
boolean |
getSendErrorToClient()
Should errors be sent to client or thrown into stderr? |
TagPluginManager |
getTagPluginManager()
Obtain a Tag Plugin Manager |
int |
getTagPoolSize()
|
TldLocationsCache |
getTldLocationsCache()
The cache for the location of the TLD's for the various tag libraries 'exposed' by the web application. |
boolean |
getTrimSpaces()
Should white spaces between directives or actions be trimmed? |
boolean |
isCaching()
Is caching enabled (used for precompilation). |
boolean |
isPoolingEnabled()
Returns true if tag handler pooling is enabled, false otherwise. |
boolean |
isSmapDumped()
Should SMAP info for JSR45 debugging be dumped to a file? |
boolean |
isSmapSuppressed()
Is the generation of SMAP info for JSR45 debuggin suppressed? |
boolean |
isXpoweredBy()
Is generation of X-Powered-By response header enabled/disabled? |
static void |
main(java.lang.String[] arg)
|
protected void |
mergeIntoWebXml()
Include the generated web.xml inside the webapp's web.xml. |
protected java.io.File |
resolveFile(java.lang.String s)
Resolves the relative or absolute pathname correctly in both Ant and command-line situations. |
void |
scanFiles(java.io.File base)
Locate all jsp files in the webapp. |
void |
setAddWebXmlMappings(boolean b)
|
void |
setArgs(java.lang.String[] arg)
|
void |
setCaching(boolean caching)
|
void |
setClassDebugInfo(boolean b)
|
void |
setClassName(java.lang.String p)
Class name of the generated file ( without package ). |
void |
setClassPath(java.lang.String s)
|
void |
setCompile(boolean b)
Sets the compile flag. |
void |
setCompiler(java.lang.String c)
|
void |
setCompilerSourceVM(java.lang.String vm)
|
void |
setCompilerTargetVM(java.lang.String vm)
|
void |
setErrorOnUseBeanInvalidClassAttribute(boolean b)
|
void |
setFailOnError(boolean b)
Set the option that throws an exception in case of a compilation error. |
void |
setGenStringAsCharArray(boolean genStringAsCharArray)
Determines whether text strings are to be generated as char arrays, which improves performance in some cases. |
void |
setIeClassId(java.lang.String ieClassId)
Sets the class-id value to be sent to Internet Explorer when using |
void |
setJavaEncoding(java.lang.String encodingName)
Sets the encoding to use for java files. |
void |
setJspFiles(java.lang.String jspFiles)
Parses comma-separated list of JSP files to be processed. |
void |
setListErrors(boolean b)
|
void |
setOutputDir(java.lang.String s)
|
void |
setPackage(java.lang.String p)
|
void |
setPoolingEnabled(boolean poolingEnabled)
|
void |
setProject(org.apache.tools.ant.Project theProject)
Sets the project. |
void |
setSmapDumped(boolean smapDumped)
Set smapSuppressed flag. |
void |
setSmapSuppressed(boolean smapSuppressed)
Set smapSuppressed flag. |
void |
setTrimSpaces(boolean ts)
|
void |
setUriroot(java.lang.String s)
Base dir for the webapp. |
void |
setValidateXml(boolean b)
|
void |
setVerbose(int level)
Sets the verbosity level. |
void |
setWebXml(java.lang.String s)
File where we generate a complete web.xml with the class definitions. |
void |
setWebXmlFragment(java.lang.String s)
File where we generate a web.xml fragment with the class definitions. |
void |
setXpoweredBy(boolean xpoweredBy)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String DEFAULT_IE_CLASS_ID
Constructor Detail |
public JspC()
Method Detail |
public static void main(java.lang.String[] arg)
public void setArgs(java.lang.String[] arg) throws JasperException
JasperException
public boolean getKeepGenerated()
Options
getKeepGenerated
in interface Options
public boolean getTrimSpaces()
Options
getTrimSpaces
in interface Options
public void setTrimSpaces(boolean ts)
public boolean isPoolingEnabled()
Options
isPoolingEnabled
in interface Options
public void setPoolingEnabled(boolean poolingEnabled)
public boolean isXpoweredBy()
Options
isXpoweredBy
in interface Options
public void setXpoweredBy(boolean xpoweredBy)
public boolean getErrorOnUseBeanInvalidClassAttribute()
Options
getErrorOnUseBeanInvalidClassAttribute
in interface Options
public void setErrorOnUseBeanInvalidClassAttribute(boolean b)
public int getTagPoolSize()
public boolean getMappedFile()
getMappedFile
in interface Options
public java.lang.Object getProtectionDomain()
public boolean getSendErrorToClient()
Options
getSendErrorToClient
in interface Options
public void setClassDebugInfo(boolean b)
public boolean getClassDebugInfo()
Options
getClassDebugInfo
in interface Options
public boolean isCaching()
Options
isCaching
in interface Options
Options.isCaching()
public void setCaching(boolean caching)
Options.isCaching()
public java.util.Map getCache()
Options
getCache
in interface Options
Options.getCache()
public int getCheckInterval()
getCheckInterval
in interface Options
public int getModificationTestInterval()
getModificationTestInterval
in interface Options
public boolean getDevelopment()
getDevelopment
in interface Options
public boolean isSmapSuppressed()
isSmapSuppressed
in interface Options
public void setSmapSuppressed(boolean smapSuppressed)
public boolean isSmapDumped()
isSmapDumped
in interface Options
public void setSmapDumped(boolean smapDumped)
public void setGenStringAsCharArray(boolean genStringAsCharArray)
genStringAsCharArray
- true if text strings are to be generated as
char arrays, false otherwisepublic boolean genStringAsCharArray()
genStringAsCharArray
in interface Options
public void setIeClassId(java.lang.String ieClassId)
ieClassId
- Class-id valuepublic java.lang.String getIeClassId()
getIeClassId
in interface Options
public java.io.File getScratchDir()
Options
getScratchDir
in interface Options
public java.lang.Class getJspCompilerPlugin()
public java.lang.String getJspCompilerPath()
public java.lang.String getCompiler()
getCompiler
in interface Options
public void setCompiler(java.lang.String c)
public java.lang.String getCompilerTargetVM()
Options
getCompilerTargetVM
in interface Options
Options.getCompilerTargetVM()
public void setCompilerTargetVM(java.lang.String vm)
public java.lang.String getCompilerSourceVM()
Options
getCompilerSourceVM
in interface Options
Options.getCompilerSourceVM()
public void setCompilerSourceVM(java.lang.String vm)
Options.getCompilerSourceVM()
public TldLocationsCache getTldLocationsCache()
Options
getTldLocationsCache
in interface Options
public java.lang.String getJavaEncoding()
getJavaEncoding
in interface Options
public void setJavaEncoding(java.lang.String encodingName)
encodingName
- The name, e.g. "UTF-8"public boolean getFork()
Options
getFork
in interface Options
public java.lang.String getClassPath()
Options
getClassPath
in interface Options
public void setClassPath(java.lang.String s)
public java.util.List getExtensions()
protected void addExtension(java.lang.String extension)
extension
- The extension to add, e.g. "myjsp"public void setProject(org.apache.tools.ant.Project theProject)
theProject
- The projectpublic org.apache.tools.ant.Project getProject()
public void setUriroot(java.lang.String s)
public void setJspFiles(java.lang.String jspFiles)
Each file is interpreted relative to uriroot, unless it is absolute, in which case it must start with uriroot.
jspFiles
- Comma-separated list of JSP files to be processedpublic void setCompile(boolean b)
b
- Flag valuepublic void setVerbose(int level)
level
- Positive means verbosepublic void setValidateXml(boolean b)
public void setListErrors(boolean b)
public void setOutputDir(java.lang.String s)
public void setPackage(java.lang.String p)
public void setClassName(java.lang.String p)
public void setWebXmlFragment(java.lang.String s)
public void setWebXml(java.lang.String s)
public void setAddWebXmlMappings(boolean b)
public void setFailOnError(boolean b)
public boolean getFailOnError()
public JspConfig getJspConfig()
getJspConfig
in interface Options
public TagPluginManager getTagPluginManager()
Options
getTagPluginManager
in interface Options
public void generateWebMapping(java.lang.String file, JspCompilationContext clctxt) throws java.io.IOException
java.io.IOException
protected void mergeIntoWebXml() throws java.io.IOException
java.io.IOException
public void scanFiles(java.io.File base) throws JasperException
JasperException
public void execute() throws JasperException
JasperException
- If an error occursprotected java.io.File resolveFile(java.lang.String s)
s
- The file
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |