org.apache.jasper
类 JspC

java.lang.Object
  org.apache.jasper.JspC

所有已实现的接口：

Options

public class JspC
extends Object
implements Options

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" />
 

作者：

Danno Ferrin, Pierre Delisle, Costin Manolache

字段摘要

static String

DEFAULT_IE_CLASS_ID

构造方法摘要

JspC()

方法摘要

void	execute()
void	generateWebMapping(String file, JspCompilationContext clctxt)
boolean	genStringAsByteArray() Are text strings to be generated as byte arrays, if the page is unbuffered?
boolean	genStringAsCharArray() Indicates whether text strings are to be generated as char arrays.
int	getCheckInterval() Background compilation check intervals in seconds
boolean	getClassDebugInfo() Should we include debug information in compiled class?
String	getClassPath() What classpath should I use while compiling the servlets generated from JSP files?
String	getCompiler() Compiler to use.
String	getCompilerSourceVM() Compiler source VM, e.g. 1.3, 1.4, or 1.5.
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?
int	getDieLevel()
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.
boolean	getFailOnError()
boolean	getFork() boolean flag to tell Ant whether to fork JSP page compilations.
String	getIeClassId() Gets the class-id value that is sent to Internet Explorer when using tags.
int	getInitialCapacity() Gets initial capacity of HashMap which maps JSPs to their corresponding servlets.
String	getJavaEncoding() Returns the encoding to use for java files.
List<JasperException>	getJSPCompilationErrors() Gets the list of JSP compilation errors caught during the most recent invocation of this instance's execute method when failOnError has been set to FALSE.
String	getJspCompilerPath()
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.
Object	getProtectionDomain()
boolean	getSaveBytecode() If class files are generated as byte arrays, should they be saved to disk at the end of compilations?
File	getScratchDir() What is my scratch dir?
boolean	getSendErrorToClient() Should errors be sent to client or thrown into stderr?
String	getSystemClassPath() Gets the system class path.
TagPluginManager	getTagPluginManager() Obtain a Tag Plugin Manager
int	getTagPoolSize()
TldScanner	getTldScanner() 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	getUsePrecompiled() Returns the value of the usePrecompiled (or use-precompiled) init param.
boolean	isDefaultBufferNone() If the buffer attribute for the page directive is not specified, is the default "none"?
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 debugging suppressed?
boolean	isValidationEnabled()
boolean	isXpoweredBy() Is generation of X-Powered-By response header enabled/disabled?
static void	main(String[] arg)
protected void	mergeIntoWebXml() Include the generated web.xml inside the webapp's web.xml.
void	scanFiles(File base) Locate all jsp files in the webapp.
void	setAddWebXmlMappings(boolean b)
void	setArgs(String[] arg)
void	setClassDebugInfo(boolean b)
void	setClassName(String p) Class name of the generated file ( without package ).
void	setClassPath(String s)
void	setCompile(boolean b)
void	setCompiler(String c)
void	setCompilerSourceVM(String vm)
void	setCompilerTargetVM(String vm)
void	setDefaultBufferNone()
static void	setDtdResourcePrefix(String prefix) Sets the path prefix for .dtd resources
void	setErrorOnUseBeanInvalidClassAttribute(boolean b)
void	setFailOnError(boolean b) Set the option that throws an exception in case of a compilation error.
void	setGenStringAsByteArray(boolean genStringAsByteArray)
void	setGenStringAsCharArray(boolean genStringAsCharArray) Determines whether text strings are to be generated as char arrays, which improves performance in some cases.
void	setIeClassId(String ieClassId) Sets the class-id value to be sent to Internet Explorer when using tags.
void	setIgnoreJspFragmentErrors(boolean ignore)
void	setIsValidationEnabled(boolean b)
void	setJavaEncoding(String encodingName) Sets the encoding to use for java files.
void	setJspFiles(String jspFiles)
void	setListErrors(boolean b)
void	setOutputDir(String s)
void	setPackage(String p)
void	setPoolingEnabled(boolean poolingEnabled)
static void	setSchemaResourcePrefix(String prefix) Sets the path prefix for .xsd resources
void	setSmapDumped(boolean smapDumped) Set smapSuppressed flag.
void	setSmapSuppressed(boolean smapSuppressed) Set smapSuppressed flag.
void	setSystemClassPath(String s) Sets the system class path.
void	setTrimSpaces(boolean ts)
void	setUriroot(String s) Base dir for the webapp.
void	setValidateXml(boolean b)
void	setVerbose(int level)
void	setWebXml(String s) File where we generate a complete web.xml with the class definitions.
void	setWebXmlFragment(String s) File where we generate a web.xml fragment with the class definitions.
void	setXpoweredBy(boolean xpoweredBy)

从类 java.lang.Object 继承的方法

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

字段详细信息

DEFAULT_IE_CLASS_ID

public static final String DEFAULT_IE_CLASS_ID

另请参见：

常量字段值

构造方法详细信息

JspC

public JspC()

方法详细信息

main

public static void main(String[] arg)

setArgs

public void setArgs(String[] arg)
             throws JasperException

抛出：

JasperException

getDieLevel

public int getDieLevel()

getKeepGenerated

public boolean getKeepGenerated()

从接口 Options 复制的描述

Are we keeping generated code around?

指定者：

接口 Options 中的 getKeepGenerated

getSaveBytecode

public boolean getSaveBytecode()

从接口 Options 复制的描述

If class files are generated as byte arrays, should they be saved to disk at the end of compilations?

指定者：

接口 Options 中的 getSaveBytecode

getTrimSpaces

public boolean getTrimSpaces()

从接口 Options 复制的描述

Should white spaces between directives or actions be trimmed?

指定者：

接口 Options 中的 getTrimSpaces

setTrimSpaces

public void setTrimSpaces(boolean ts)

isPoolingEnabled

public boolean isPoolingEnabled()

从接口 Options 复制的描述

Returns true if tag handler pooling is enabled, false otherwise.

指定者：

接口 Options 中的 isPoolingEnabled

setPoolingEnabled

public void setPoolingEnabled(boolean poolingEnabled)

isXpoweredBy

public boolean isXpoweredBy()

从接口 Options 复制的描述

Is generation of X-Powered-By response header enabled/disabled?

指定者：

接口 Options 中的 isXpoweredBy

setXpoweredBy

public void setXpoweredBy(boolean xpoweredBy)

getErrorOnUseBeanInvalidClassAttribute

public boolean getErrorOnUseBeanInvalidClassAttribute()

从接口 Options 复制的描述

Returns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.

指定者：

接口 Options 中的 getErrorOnUseBeanInvalidClassAttribute

setErrorOnUseBeanInvalidClassAttribute

public void setErrorOnUseBeanInvalidClassAttribute(boolean b)

getTagPoolSize

public int getTagPoolSize()

getInitialCapacity

public int getInitialCapacity()

Gets initial capacity of HashMap which maps JSPs to their corresponding servlets.

指定者：

接口 Options 中的 getInitialCapacity

getMappedFile

public boolean getMappedFile()

Are we supporting HTML mapped servlets?

指定者：

接口 Options 中的 getMappedFile

getProtectionDomain

public Object getProtectionDomain()

getSendErrorToClient

public boolean getSendErrorToClient()

从接口 Options 复制的描述

Should errors be sent to client or thrown into stderr?

指定者：

接口 Options 中的 getSendErrorToClient

setClassDebugInfo

public void setClassDebugInfo(boolean b)

getClassDebugInfo

public boolean getClassDebugInfo()

从接口 Options 复制的描述

Should we include debug information in compiled class?

指定者：

接口 Options 中的 getClassDebugInfo

getCheckInterval

public int getCheckInterval()

Background compilation check intervals in seconds

指定者：

接口 Options 中的 getCheckInterval

getModificationTestInterval

public int getModificationTestInterval()

Modification test interval.

指定者：

接口 Options 中的 getModificationTestInterval

getDevelopment

public boolean getDevelopment()

Is Jasper being used in development mode?

指定者：

接口 Options 中的 getDevelopment

getUsePrecompiled

public boolean getUsePrecompiled()

从接口 Options 复制的描述

Returns the value of the usePrecompiled (or use-precompiled) init param.

指定者：

接口 Options 中的 getUsePrecompiled

isSmapSuppressed

public boolean isSmapSuppressed()

Is the generation of SMAP info for JSR45 debugging suppressed?

指定者：

接口 Options 中的 isSmapSuppressed

setSmapSuppressed

public void setSmapSuppressed(boolean smapSuppressed)

Set smapSuppressed flag.

isSmapDumped

public boolean isSmapDumped()

Should SMAP info for JSR45 debugging be dumped to a file?

指定者：

接口 Options 中的 isSmapDumped

setSmapDumped

public void setSmapDumped(boolean smapDumped)

Set smapSuppressed flag.

setGenStringAsCharArray

public void setGenStringAsCharArray(boolean genStringAsCharArray)

Determines whether text strings are to be generated as char arrays, which improves performance in some cases.

参数：

genStringAsCharArray - true if text strings are to be generated as char arrays, false otherwise

genStringAsCharArray

public boolean genStringAsCharArray()

Indicates whether text strings are to be generated as char arrays.

指定者：

接口 Options 中的 genStringAsCharArray

返回：

true if text strings are to be generated as char arrays, false otherwise

setGenStringAsByteArray

public void setGenStringAsByteArray(boolean genStringAsByteArray)

genStringAsByteArray

public boolean genStringAsByteArray()

从接口 Options 复制的描述

Are text strings to be generated as byte arrays, if the page is unbuffered?

指定者：

接口 Options 中的 genStringAsByteArray

isDefaultBufferNone

public boolean isDefaultBufferNone()

从接口 Options 复制的描述

If the buffer attribute for the page directive is not specified, is the default "none"?

指定者：

接口 Options 中的 isDefaultBufferNone

setDefaultBufferNone

public void setDefaultBufferNone()

setIeClassId

public void setIeClassId(String ieClassId)

Sets the class-id value to be sent to Internet Explorer when using tags.

参数：

ieClassId - Class-id value

getIeClassId

public String getIeClassId()

Gets the class-id value that is sent to Internet Explorer when using tags.

指定者：

接口 Options 中的 getIeClassId

返回：

Class-id value

getScratchDir

public File getScratchDir()

从接口 Options 复制的描述

What is my scratch dir?

指定者：

接口 Options 中的 getScratchDir

getJspCompilerPlugin

public Class getJspCompilerPlugin()

getJspCompilerPath

public String getJspCompilerPath()

getCompiler

public String getCompiler()

Compiler to use.

指定者：

接口 Options 中的 getCompiler

setCompiler

public void setCompiler(String c)

getCompilerTargetVM

public String getCompilerTargetVM()

从接口 Options 复制的描述

The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, or 1.5.

指定者：

接口 Options 中的 getCompilerTargetVM

另请参见：

Options.getCompilerTargetVM()

setCompilerTargetVM

public void setCompilerTargetVM(String vm)

getCompilerSourceVM

public String getCompilerSourceVM()

从接口 Options 复制的描述

Compiler source VM, e.g. 1.3, 1.4, or 1.5.

指定者：

接口 Options 中的 getCompilerSourceVM

另请参见：

Options#getCompilerSourceVM.

setCompilerSourceVM

public void setCompilerSourceVM(String vm)

另请参见：

Options#getCompilerSourceVM.

getTldScanner

public TldScanner getTldScanner()

从接口 Options 复制的描述

The cache for the location of the TLD's for the various tag libraries 'exposed' by the web application. A tag library is 'exposed' either explicitely in web.xml or implicitely via the uri tag in the TLD of a taglib deployed in a jar file (WEB-INF/lib).

指定者：

接口 Options 中的 getTldScanner

返回：

the instance of the TldScanner for the web-application.

getJavaEncoding

public String getJavaEncoding()

Returns the encoding to use for java files. The default is UTF-8.

指定者：

接口 Options 中的 getJavaEncoding

返回：

String The encoding

setJavaEncoding

public void setJavaEncoding(String encodingName)

Sets the encoding to use for java files.

参数：

encodingName - The name, e.g. "UTF-8"

getFork

public boolean getFork()

从接口 Options 复制的描述

boolean flag to tell Ant whether to fork JSP page compilations.

指定者：

接口 Options 中的 getFork

getClassPath

public String getClassPath()

从接口 Options 复制的描述

What classpath should I use while compiling the servlets generated from JSP files?

指定者：

接口 Options 中的 getClassPath

setClassPath

public void setClassPath(String s)

getSystemClassPath

public String getSystemClassPath()

Gets the system class path.

指定者：

接口 Options 中的 getSystemClassPath

返回：

The system class path

setSystemClassPath

public void setSystemClassPath(String s)

Sets the system class path.

参数：

s - The system class path to use

setUriroot

public void setUriroot(String s)

Base dir for the webapp. Used to generate class names and resolve includes

setSchemaResourcePrefix

public static void setSchemaResourcePrefix(String prefix)

Sets the path prefix for .xsd resources

setDtdResourcePrefix

public static void setDtdResourcePrefix(String prefix)

Sets the path prefix for .dtd resources

setJspFiles

public void setJspFiles(String jspFiles)

setCompile

public void setCompile(boolean b)

setVerbose

public void setVerbose(int level)

setValidateXml

public void setValidateXml(boolean b)

setIsValidationEnabled

public void setIsValidationEnabled(boolean b)

isValidationEnabled

public boolean isValidationEnabled()

指定者：

接口 Options 中的 isValidationEnabled

setListErrors

public void setListErrors(boolean b)

setOutputDir

public void setOutputDir(String s)

setPackage

public void setPackage(String p)

setClassName

public void setClassName(String p)

Class name of the generated file ( without package ). Can only be used if a single file is converted. XXX Do we need this feature ?

setWebXmlFragment

public void setWebXmlFragment(String s)

File where we generate a web.xml fragment with the class definitions.

setWebXml

public void setWebXml(String s)

File where we generate a complete web.xml with the class definitions.

setAddWebXmlMappings

public void setAddWebXmlMappings(boolean b)

setFailOnError

public void setFailOnError(boolean b)

Set the option that throws an exception in case of a compilation error.

getFailOnError

public boolean getFailOnError()

setIgnoreJspFragmentErrors

public void setIgnoreJspFragmentErrors(boolean ignore)

getJspConfig

public JspConfig getJspConfig()

Obtain JSP configuration informantion specified in web.xml.

指定者：

接口 Options 中的 getJspConfig

getTagPluginManager

public TagPluginManager getTagPluginManager()

从接口 Options 复制的描述

Obtain a Tag Plugin Manager

指定者：

接口 Options 中的 getTagPluginManager

generateWebMapping

public void generateWebMapping(String file,
                               JspCompilationContext clctxt)
                        throws IOException

抛出：

IOException

getJSPCompilationErrors

public List<JasperException> getJSPCompilationErrors()

Gets the list of JSP compilation errors caught during the most recent invocation of this instance's execute method when failOnError has been set to FALSE. Each error error in the list is represented by an instance of org.apache.jasper.JasperException.

返回：

List of JSP compilation errors caught during most recent invocation of this instance's execute method, or an empty list if no errors were encountered or this instance's failOnError property was set to TRUE

mergeIntoWebXml

protected void mergeIntoWebXml()
                        throws IOException

Include the generated web.xml inside the webapp's web.xml.

抛出：

IOException

scanFiles

public void scanFiles(File base)
               throws JasperException

Locate all jsp files in the webapp. Used if no explicit jsps are specified.

抛出：

JasperException

execute

public void execute()
             throws JasperException

抛出：

JasperException