Class JspC
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.jasper.JspC
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- Options
 
 public class JspC extends org.apache.tools.ant.Task 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="jasper" > <classpath> <pathelement location="${java.home}/../lib/tools.jar"/> <fileset dir="${ENV.CATALINA_HOME}/lib"> <include name="*.jar"/> </fileset> <path refid="myjars"/> </classpath> </taskdef> <jasper 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" />- Author:
- Danno Ferrin, Pierre Delisle, Costin Manolache, Yoav Shapira
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected booleanaddWebXmlMappingsprotected static intALL_WEBXMLprotected intargPosprotected java.lang.String[]argsprotected booleanblockExternalprotected java.util.Map<java.lang.String,TagLibraryInfo>cacheprotected booleancachingprotected booleanclassDebugInfoprotected java.lang.StringclassPathprotected booleancompileprotected java.lang.Stringcompilerprotected java.lang.StringcompilerSourceVMprotected java.lang.StringcompilerTargetVMprotected JspCServletContextcontextThe servlet context.protected static intDEFAULT_DIE_LEVELstatic java.lang.StringDEFAULT_IE_CLASS_IDDeprecated.protected intdieLevelprotected booleanerrorOnUseBeanInvalidClassAttributeNeeds better documentation, this data member does.protected java.util.List<java.lang.String>extensionsThe file extensions to be handled as JSP files.protected booleanfailFastprotected booleanfailOnErrorThrow an exception if there's a compilation error, or swallow it.protected static intFRG_WEBXMLprotected booleanfullstopprotected booleangenStringAsCharArrayprotected booleanhelpNeededprotected java.lang.StringieClassIdprotected static intINC_WEBXMLprotected static java.util.Set<java.lang.String>insertBeforeprotected java.lang.StringjavaEncodingThe java file encoding.protected JspConfigjspConfigprotected static java.lang.StringLIST_ERRORSprotected booleanlistErrorsprotected java.lang.ClassLoaderloaderprotected java.io.Writermapoutprotected booleanmappedFileprotected java.io.CharArrayWritermappingoutprotected static intNO_DIE_LEVELprotected java.util.List<java.lang.String>pagesThe pages.protected booleanpoolingEnabledprotected booleanquoteAttributeELprotected JspRuntimeContextrctxtThe runtime context.protected TldScannerscannerprotected java.io.FilescratchDirprotected java.io.CharArrayWriterservletoutprotected static java.lang.StringSHOW_SUCCESSprotected booleanshowSuccessprotected booleansmapDumpedprotected booleansmapSuppressedprotected booleanstrictQuoteEscapingprotected static java.lang.StringSWITCH_ADD_WEBAPP_XML_MAPPINGSprotected static java.lang.StringSWITCH_CACHEprotected static java.lang.StringSWITCH_CLASS_NAMEprotected static java.lang.StringSWITCH_CLASSPATHprotected static java.lang.StringSWITCH_COMPILEprotected static java.lang.StringSWITCH_DIEprotected static java.lang.StringSWITCH_DUMP_SMAPprotected static java.lang.StringSWITCH_ENCODINGprotected static java.lang.StringSWITCH_FAIL_FASTprotected static java.lang.StringSWITCH_FILE_WEBAPPprotected static java.lang.StringSWITCH_FULL_STOPprotected static java.lang.StringSWITCH_HELPprotected static java.lang.StringSWITCH_MAPPEDprotected static java.lang.StringSWITCH_NO_BLOCK_EXTERNALprotected static java.lang.StringSWITCH_NO_QUOTE_ATTRIBUTE_ELprotected static java.lang.StringSWITCH_NO_STRICT_QUOTE_ESCAPINGprotected static java.lang.StringSWITCH_OUTPUT_DIRprotected static java.lang.StringSWITCH_PACKAGE_NAMEprotected static java.lang.StringSWITCH_POOLINGprotected static java.lang.StringSWITCH_QUOTE_ATTRIBUTE_ELprotected static java.lang.StringSWITCH_SMAPprotected static java.lang.StringSWITCH_SOURCEprotected static java.lang.StringSWITCH_TARGETprotected static java.lang.StringSWITCH_THREAD_COUNTprotected static java.lang.StringSWITCH_TRIM_SPACESprotected static java.lang.StringSWITCH_URI_BASEprotected static java.lang.StringSWITCH_URI_ROOTprotected static java.lang.StringSWITCH_VALIDATE_TLDprotected static java.lang.StringSWITCH_VALIDATE_XMLprotected static java.lang.StringSWITCH_VERBOSEprotected static java.lang.StringSWITCH_WEBAPP_FRGprotected static java.lang.StringSWITCH_WEBAPP_INCprotected static java.lang.StringSWITCH_WEBAPP_XMLprotected static java.lang.StringSWITCH_WEBAPP_XML_ENCODINGprotected static java.lang.StringSWITCH_XPOWERED_BYprotected TagPluginManagertagPluginManagerprotected java.lang.StringtargetClassNameprotected java.lang.StringtargetPackageprotected intthreadCountThe number of threads to use; default is one per coreprotected TldCachetldCacheCache for the TLD locationsprotected TrimSpacesOptiontrimSpacesprotected java.lang.StringuriBaseprotected java.lang.StringuriRootprotected booleanvalidateTldprotected booleanvalidateXmlprotected booleanverboseprotected java.lang.StringwebxmlEncodingprotected java.lang.StringwebxmlFileprotected intwebxmlLevelprotected booleanxpoweredBy
 - 
Constructor SummaryConstructors Constructor Description JspC()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidaddExtension(java.lang.String extension)Adds the given file extension to the list of extensions handled as JSP files.protected voidcompleteWebXml()voidexecute()Executes the compilation.voidgenerateWebMapping(java.lang.String file, JspCompilationContext clctxt)Adds servlet declaration and mapping for the JSP page servlet to the generated web.xml fragment.booleangenStringAsCharArray()Indicates whether text strings are to be generated as char arrays.java.util.Map<java.lang.String,TagLibraryInfo>getCache()The web-application wide cache for the TagLibraryInfo tag library descriptors, used ifOptions.isCaching()returnstrue.intgetCheckInterval()In JspC this always returns0.booleangetClassDebugInfo()java.lang.StringgetClassPath()java.lang.StringgetCompiler()Compiler to use.java.lang.StringgetCompilerClassName()java.lang.StringgetCompilerSourceVM()java.lang.StringgetCompilerTargetVM()booleangetDevelopment()In JspC this always returnsfalse.booleangetDisplaySourceFragment()In JspC this always returnstrue.booleangetErrorOnUseBeanInvalidClassAttribute()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<java.lang.String>getExtensions()Returns the list of file extensions that are treated as JSP files.booleangetFailOnError()booleangetFork()The boolean flag to tell Ant whether to fork JSP page compilations.booleangetGeneratedJavaAddTimestamp()Should the container include the time the file was generated in the comments at the start of a Java file generated from a JSP or tag.java.lang.StringgetIeClassId()Deprecated.java.lang.StringgetJavaEncoding()Returns the encoding to use for java files.JspConfiggetJspConfig()intgetJspIdleTimeout()booleangetKeepGenerated()In JspC this always returnstrue.booleangetMappedFile()intgetMaxLoadedJsps()The maximum number of loaded jsps per web-application.intgetModificationTestInterval()In JspC this always returns0.booleangetQuoteAttributeEL()booleangetRecompileOnFail()In JspC this always returnsfalse.java.io.FilegetScratchDir()booleangetStrictQuoteEscaping()TagPluginManagergetTagPluginManager()intgetThreadCount()TldCachegetTldCache()The cache that maps URIs, resource paths and parsed TLD files for the various tag libraries 'exposed' by the web application.TrimSpacesOptiongetTrimSpaces()protected java.lang.ClassLoaderinitClassLoader()Initializes the classloader as/if needed for the given compilation context.protected voidinitServletContext(java.lang.ClassLoader classLoader)protected voidinitTldScanner(JspCServletContext context, java.lang.ClassLoader classLoader)protected voidinitWebXml()booleanisBlockExternal()booleanisCaching()booleanisPoolingEnabled()booleanisSmapDumped()This setting is ignored if suppressSmap() istrue.booleanisSmapSuppressed()booleanisValidateTld()booleanisValidateXml()booleanisXpoweredBy()protected voidlocateUriRoot(java.io.File f)Find the WEB-INF dir by looking up in the directory tree.static voidmain(java.lang.String[] arg)protected voidmergeIntoWebXml()Include the generated web.xml inside the webapp's web.xml.protected TldScannernewTldScanner(JspCServletContext context, boolean namespaceAware, boolean validate, boolean blockExternal)protected java.lang.StringnextArg()protected java.lang.StringnextFile()protected voidprocessFile(java.lang.String file)protected java.io.FileresolveFile(java.lang.String s)Resolves the relative or absolute pathname correctly in both Ant and command-line situations.voidscanFiles()Locate all jsp files in the webapp.voidscanFiles(java.io.File base)Deprecated.This will be removed in Tomcat 10.voidsetAddWebXmlMappings(boolean b)Sets the option to merge generated web.xml fragment into the WEB-INF/web.xml file of the web application that we were processing.voidsetArgs(java.lang.String[] arg)Apply command-line arguments.voidsetBlockExternal(boolean b)voidsetCaching(boolean caching)Sets the option to enable caching.voidsetClassDebugInfo(boolean b)Sets the option to include debug information in compiled class.voidsetClassName(java.lang.String p)Class name of the generated file ( without package ).voidsetClassPath(java.lang.String s)Sets the classpath used while compiling the servlets generated from JSP filesvoidsetCompile(boolean b)Sets the compile flag.voidsetCompiler(java.lang.String c)Sets the option to determine what compiler to use.voidsetCompilerSourceVM(java.lang.String vm)Sets the compiler source VM.voidsetCompilerTargetVM(java.lang.String vm)Sets the compiler target VM.voidsetErrorOnUseBeanInvalidClassAttribute(boolean b)Sets the option to issue a compilation error if the class attribute specified in useBean action is invalid.voidsetFailOnError(boolean b)Sets the option that throws an exception in case of a compilation error.voidsetFork(boolean fork)voidsetGenStringAsCharArray(boolean genStringAsCharArray)Determines whether text strings are to be generated as char arrays, which improves performance in some cases.voidsetIeClassId(java.lang.String ieClassId)Deprecated.Will be removed in Tomcat 10.1voidsetJavaEncoding(java.lang.String encodingName)Sets the encoding to use for java files.voidsetJspFiles(java.lang.String jspFiles)Parses comma-separated list of JSP files to be processed.voidsetListErrors(boolean b)voidsetMappedFile(boolean b)voidsetOutputDir(java.lang.String s)voidsetPackage(java.lang.String p)Sets the package name to be used for the generated servlet classes.voidsetPoolingEnabled(boolean poolingEnabled)Sets the option to enable the tag handler pooling.voidsetQuoteAttributeEL(boolean b)voidsetSmapDumped(boolean smapDumped)Sets smapDumped flag.voidsetSmapSuppressed(boolean smapSuppressed)Sets smapSuppressed flag.voidsetStrictQuoteEscaping(boolean b)voidsetThreadCount(java.lang.String threadCount)voidsetTrimSpaces(boolean trimSpaces)voidsetTrimSpaces(java.lang.String ts)Sets the option to control handling of template text that consists entirely of whitespace.voidsetTrimSpaces(TrimSpacesOption trimSpaces)voidsetUriroot(java.lang.String s)Base dir for the webapp.voidsetValidateTld(boolean b)voidsetValidateXml(boolean b)voidsetVerbose(int level)Sets the verbosity level.voidsetWebFragmentXml(java.lang.String s)File where we generate a complete web-fragment.xml with the class definitions.voidsetWebXml(java.lang.String s)File where we generate a complete web.xml with the class definitions.voidsetWebXmlEncoding(java.lang.String encoding)Sets the encoding to be used to read and write web.xml files.voidsetWebXmlFragment(java.lang.String s)Deprecated.Will be removed in Tomcat 10.voidsetWebXmlInclude(java.lang.String s)File where we generate configuration with the class definitions to be included in a web.xml file.voidsetXpoweredBy(boolean xpoweredBy)Sets the option to enable generation of X-Powered-By response header.- 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
- 
 
- 
- 
- 
Field Detail- 
DEFAULT_IE_CLASS_ID@Deprecated public static final java.lang.String DEFAULT_IE_CLASS_ID Deprecated.- See Also:
- Constant Field Values
 
 - 
SWITCH_VERBOSEprotected static final java.lang.String SWITCH_VERBOSE - See Also:
- Constant Field Values
 
 - 
SWITCH_HELPprotected static final java.lang.String SWITCH_HELP - See Also:
- Constant Field Values
 
 - 
SWITCH_OUTPUT_DIRprotected static final java.lang.String SWITCH_OUTPUT_DIR - See Also:
- Constant Field Values
 
 - 
SWITCH_PACKAGE_NAMEprotected static final java.lang.String SWITCH_PACKAGE_NAME - See Also:
- Constant Field Values
 
 - 
SWITCH_CACHEprotected static final java.lang.String SWITCH_CACHE - See Also:
- Constant Field Values
 
 - 
SWITCH_CLASS_NAMEprotected static final java.lang.String SWITCH_CLASS_NAME - See Also:
- Constant Field Values
 
 - 
SWITCH_FULL_STOPprotected static final java.lang.String SWITCH_FULL_STOP - See Also:
- Constant Field Values
 
 - 
SWITCH_COMPILEprotected static final java.lang.String SWITCH_COMPILE - See Also:
- Constant Field Values
 
 - 
SWITCH_FAIL_FASTprotected static final java.lang.String SWITCH_FAIL_FAST - See Also:
- Constant Field Values
 
 - 
SWITCH_SOURCEprotected static final java.lang.String SWITCH_SOURCE - See Also:
- Constant Field Values
 
 - 
SWITCH_TARGETprotected static final java.lang.String SWITCH_TARGET - See Also:
- Constant Field Values
 
 - 
SWITCH_URI_BASEprotected static final java.lang.String SWITCH_URI_BASE - See Also:
- Constant Field Values
 
 - 
SWITCH_URI_ROOTprotected static final java.lang.String SWITCH_URI_ROOT - See Also:
- Constant Field Values
 
 - 
SWITCH_FILE_WEBAPPprotected static final java.lang.String SWITCH_FILE_WEBAPP - See Also:
- Constant Field Values
 
 - 
SWITCH_WEBAPP_INCprotected static final java.lang.String SWITCH_WEBAPP_INC - See Also:
- Constant Field Values
 
 - 
SWITCH_WEBAPP_FRGprotected static final java.lang.String SWITCH_WEBAPP_FRG - See Also:
- Constant Field Values
 
 - 
SWITCH_WEBAPP_XMLprotected static final java.lang.String SWITCH_WEBAPP_XML - See Also:
- Constant Field Values
 
 - 
SWITCH_WEBAPP_XML_ENCODINGprotected static final java.lang.String SWITCH_WEBAPP_XML_ENCODING - See Also:
- Constant Field Values
 
 - 
SWITCH_ADD_WEBAPP_XML_MAPPINGSprotected static final java.lang.String SWITCH_ADD_WEBAPP_XML_MAPPINGS - See Also:
- Constant Field Values
 
 - 
SWITCH_MAPPEDprotected static final java.lang.String SWITCH_MAPPED - See Also:
- Constant Field Values
 
 - 
SWITCH_XPOWERED_BYprotected static final java.lang.String SWITCH_XPOWERED_BY - See Also:
- Constant Field Values
 
 - 
SWITCH_TRIM_SPACESprotected static final java.lang.String SWITCH_TRIM_SPACES - See Also:
- Constant Field Values
 
 - 
SWITCH_CLASSPATHprotected static final java.lang.String SWITCH_CLASSPATH - See Also:
- Constant Field Values
 
 - 
SWITCH_DIEprotected static final java.lang.String SWITCH_DIE - See Also:
- Constant Field Values
 
 - 
SWITCH_POOLINGprotected static final java.lang.String SWITCH_POOLING - See Also:
- Constant Field Values
 
 - 
SWITCH_ENCODINGprotected static final java.lang.String SWITCH_ENCODING - See Also:
- Constant Field Values
 
 - 
SWITCH_SMAPprotected static final java.lang.String SWITCH_SMAP - See Also:
- Constant Field Values
 
 - 
SWITCH_DUMP_SMAPprotected static final java.lang.String SWITCH_DUMP_SMAP - See Also:
- Constant Field Values
 
 - 
SWITCH_VALIDATE_TLDprotected static final java.lang.String SWITCH_VALIDATE_TLD - See Also:
- Constant Field Values
 
 - 
SWITCH_VALIDATE_XMLprotected static final java.lang.String SWITCH_VALIDATE_XML - See Also:
- Constant Field Values
 
 - 
SWITCH_NO_BLOCK_EXTERNALprotected static final java.lang.String SWITCH_NO_BLOCK_EXTERNAL - See Also:
- Constant Field Values
 
 - 
SWITCH_NO_STRICT_QUOTE_ESCAPINGprotected static final java.lang.String SWITCH_NO_STRICT_QUOTE_ESCAPING - See Also:
- Constant Field Values
 
 - 
SWITCH_QUOTE_ATTRIBUTE_ELprotected static final java.lang.String SWITCH_QUOTE_ATTRIBUTE_EL - See Also:
- Constant Field Values
 
 - 
SWITCH_NO_QUOTE_ATTRIBUTE_ELprotected static final java.lang.String SWITCH_NO_QUOTE_ATTRIBUTE_EL - See Also:
- Constant Field Values
 
 - 
SWITCH_THREAD_COUNTprotected static final java.lang.String SWITCH_THREAD_COUNT - See Also:
- Constant Field Values
 
 - 
SHOW_SUCCESSprotected static final java.lang.String SHOW_SUCCESS - See Also:
- Constant Field Values
 
 - 
LIST_ERRORSprotected static final java.lang.String LIST_ERRORS - See Also:
- Constant Field Values
 
 - 
INC_WEBXMLprotected static final int INC_WEBXML - See Also:
- Constant Field Values
 
 - 
FRG_WEBXMLprotected static final int FRG_WEBXML - See Also:
- Constant Field Values
 
 - 
ALL_WEBXMLprotected static final int ALL_WEBXML - See Also:
- Constant Field Values
 
 - 
DEFAULT_DIE_LEVELprotected static final int DEFAULT_DIE_LEVEL - See Also:
- Constant Field Values
 
 - 
NO_DIE_LEVELprotected static final int NO_DIE_LEVEL - See Also:
- Constant Field Values
 
 - 
insertBeforeprotected static final java.util.Set<java.lang.String> insertBefore 
 - 
classPathprotected java.lang.String classPath 
 - 
loaderprotected java.lang.ClassLoader loader 
 - 
trimSpacesprotected TrimSpacesOption trimSpaces 
 - 
genStringAsCharArrayprotected boolean genStringAsCharArray 
 - 
validateTldprotected boolean validateTld 
 - 
validateXmlprotected boolean validateXml 
 - 
blockExternalprotected boolean blockExternal 
 - 
strictQuoteEscapingprotected boolean strictQuoteEscaping 
 - 
quoteAttributeELprotected boolean quoteAttributeEL 
 - 
xpoweredByprotected boolean xpoweredBy 
 - 
mappedFileprotected boolean mappedFile 
 - 
poolingEnabledprotected boolean poolingEnabled 
 - 
scratchDirprotected java.io.File scratchDir 
 - 
ieClassIdprotected java.lang.String ieClassId 
 - 
targetPackageprotected java.lang.String targetPackage 
 - 
targetClassNameprotected java.lang.String targetClassName 
 - 
uriBaseprotected java.lang.String uriBase 
 - 
uriRootprotected java.lang.String uriRoot 
 - 
dieLevelprotected int dieLevel 
 - 
helpNeededprotected boolean helpNeeded 
 - 
compileprotected boolean compile 
 - 
failFastprotected boolean failFast 
 - 
smapSuppressedprotected boolean smapSuppressed 
 - 
smapDumpedprotected boolean smapDumped 
 - 
cachingprotected boolean caching 
 - 
cacheprotected final java.util.Map<java.lang.String,TagLibraryInfo> cache 
 - 
compilerprotected java.lang.String compiler 
 - 
compilerTargetVMprotected java.lang.String compilerTargetVM 
 - 
compilerSourceVMprotected java.lang.String compilerSourceVM 
 - 
classDebugInfoprotected boolean classDebugInfo 
 - 
failOnErrorprotected boolean failOnError Throw an exception if there's a compilation error, or swallow it. Default is true to preserve old behavior.
 - 
extensionsprotected java.util.List<java.lang.String> extensions The file extensions to be handled as JSP files. Default list is .jsp and .jspx.
 - 
pagesprotected final java.util.List<java.lang.String> pages The pages.
 - 
errorOnUseBeanInvalidClassAttributeprotected boolean errorOnUseBeanInvalidClassAttribute Needs better documentation, this data member does. True by default.
 - 
javaEncodingprotected java.lang.String javaEncoding The java file encoding. Default is UTF-8. Added per bugzilla 19622.
 - 
threadCountprotected int threadCount The number of threads to use; default is one per core
 - 
webxmlFileprotected java.lang.String webxmlFile 
 - 
webxmlLevelprotected int webxmlLevel 
 - 
webxmlEncodingprotected java.lang.String webxmlEncoding 
 - 
addWebXmlMappingsprotected boolean addWebXmlMappings 
 - 
mapoutprotected java.io.Writer mapout 
 - 
servletoutprotected java.io.CharArrayWriter servletout 
 - 
mappingoutprotected java.io.CharArrayWriter mappingout 
 - 
contextprotected JspCServletContext context The servlet context.
 - 
rctxtprotected JspRuntimeContext rctxt The runtime context. Maintain a dummy JspRuntimeContext for compiling tag files.
 - 
tldCacheprotected TldCache tldCache Cache for the TLD locations
 - 
jspConfigprotected JspConfig jspConfig 
 - 
tagPluginManagerprotected TagPluginManager tagPluginManager 
 - 
scannerprotected TldScanner scanner 
 - 
verboseprotected boolean verbose 
 - 
listErrorsprotected boolean listErrors 
 - 
showSuccessprotected boolean showSuccess 
 - 
argPosprotected int argPos 
 - 
fullstopprotected boolean fullstop 
 - 
argsprotected java.lang.String[] args 
 
- 
 - 
Method Detail- 
mainpublic static void main(java.lang.String[] arg) 
 - 
setArgspublic void setArgs(java.lang.String[] arg) throws JasperExceptionApply command-line arguments.- Parameters:
- arg- The arguments
- Throws:
- JasperException- JSPC error
 
 - 
getKeepGeneratedpublic boolean getKeepGenerated() In JspC this always returnstrue.- Specified by:
- getKeepGeneratedin interface- Options
- Returns:
- trueto keep the generated source
 
 - 
getTrimSpacespublic TrimSpacesOption getTrimSpaces() - Specified by:
- getTrimSpacesin interface- Options
- Returns:
- TrimSpacesOption.TRUEto remove template text that consists only of whitespace from the output completely,- TrimSpacesOption.SINGLEto replace such template text with a single space,- TrimSpacesOption.FALSEto leave such template text unchanged or- TrimSpacesOption.EXTENDEDto remove template text that consists only of whitespace and to replace any sequence of whitespace and new lines within template text with a single new line.
 
 - 
setTrimSpacespublic void setTrimSpaces(TrimSpacesOption trimSpaces) 
 - 
setTrimSpacespublic void setTrimSpaces(java.lang.String ts) Sets the option to control handling of template text that consists entirely of whitespace.- Parameters:
- ts- New value
 
 - 
setTrimSpacespublic void setTrimSpaces(boolean trimSpaces) 
 - 
isPoolingEnabledpublic boolean isPoolingEnabled() - Specified by:
- isPoolingEnabledin interface- Options
- Returns:
- trueif tag handler pooling is enabled,- falseotherwise.
 
 - 
setPoolingEnabledpublic void setPoolingEnabled(boolean poolingEnabled) Sets the option to enable the tag handler pooling.- Parameters:
- poolingEnabled- New value
 
 - 
isXpoweredBypublic boolean isXpoweredBy() - Specified by:
- isXpoweredByin interface- Options
- Returns:
- trueto generate a X-Powered-By response header.
 
 - 
setXpoweredBypublic void setXpoweredBy(boolean xpoweredBy) Sets the option to enable generation of X-Powered-By response header.- Parameters:
- xpoweredBy- New value
 
 - 
getDisplaySourceFragmentpublic boolean getDisplaySourceFragment() In JspC this always returnstrue.- Specified by:
- getDisplaySourceFragmentin interface- Options
- Returns:
- trueto include a source fragment in exception messages.
 
 - 
getMaxLoadedJspspublic int getMaxLoadedJsps() Description copied from interface:OptionsThe maximum number of loaded jsps per web-application. If there are more jsps loaded, they will be unloaded. If unset or less than 0, no jsps are unloaded.- Specified by:
- getMaxLoadedJspsin interface- Options
- Returns:
- The JSP count
 
 - 
getJspIdleTimeoutpublic int getJspIdleTimeout() - Specified by:
- getJspIdleTimeoutin interface- Options
- Returns:
- the idle time in seconds after which a JSP is unloaded. If unset or less or equal than 0, no jsps are unloaded.
 
 - 
getErrorOnUseBeanInvalidClassAttributepublic boolean getErrorOnUseBeanInvalidClassAttribute() Description copied from interface:OptionsReturns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.- Specified by:
- getErrorOnUseBeanInvalidClassAttributein interface- Options
- Returns:
- trueto get an error
 
 - 
setErrorOnUseBeanInvalidClassAttributepublic void setErrorOnUseBeanInvalidClassAttribute(boolean b) Sets the option to issue a compilation error if the class attribute specified in useBean action is invalid.- Parameters:
- b- New value
 
 - 
getMappedFilepublic boolean getMappedFile() - Specified by:
- getMappedFilein interface- Options
- Returns:
- trueif HTML mapped Servlets are supported.
 
 - 
setMappedFilepublic void setMappedFile(boolean b) 
 - 
setClassDebugInfopublic void setClassDebugInfo(boolean b) Sets the option to include debug information in compiled class.- Parameters:
- b- New value
 
 - 
getClassDebugInfopublic boolean getClassDebugInfo() - Specified by:
- getClassDebugInfoin interface- Options
- Returns:
- trueif debug information in included in compiled classes.
 
 - 
isCachingpublic boolean isCaching() 
 - 
setCachingpublic void setCaching(boolean caching) Sets the option to enable caching.- Parameters:
- caching- New value
- See Also:
- Options.isCaching()
 
 - 
getCachepublic java.util.Map<java.lang.String,TagLibraryInfo> getCache() Description copied from interface:OptionsThe web-application wide cache for the TagLibraryInfo tag library descriptors, used ifOptions.isCaching()returnstrue.Using this cache avoids the cost of repeating the parsing of a tag library descriptor XML file (performed by TagLibraryInfoImpl.parseTLD). 
 - 
getCheckIntervalpublic int getCheckInterval() In JspC this always returns0.- Specified by:
- getCheckIntervalin interface- Options
- Returns:
- background compile thread check interval in seconds
 
 - 
getModificationTestIntervalpublic int getModificationTestInterval() In JspC this always returns0.- Specified by:
- getModificationTestIntervalin interface- Options
- Returns:
- modification test interval.
 
 - 
getRecompileOnFailpublic boolean getRecompileOnFail() In JspC this always returnsfalse.- Specified by:
- getRecompileOnFailin interface- Options
- Returns:
- trueif re-compile will occur on a failure.
 
 - 
getDevelopmentpublic boolean getDevelopment() In JspC this always returnsfalse. Main development flag, which enables detailed error reports with sources, as well automatic recompilation of JSPs and tag files. This setting should usually befalsewhen running in production.- Specified by:
- getDevelopmentin interface- Options
- Returns:
- trueif Jasper is in development mode
 
 - 
isSmapSuppressedpublic boolean isSmapSuppressed() - Specified by:
- isSmapSuppressedin interface- Options
- Returns:
- trueto suppress generation of SMAP info for JSR45 debugging.
 
 - 
setSmapSuppressedpublic void setSmapSuppressed(boolean smapSuppressed) Sets smapSuppressed flag.- Parameters:
- smapSuppressed- New value
 
 - 
isSmapDumpedpublic boolean isSmapDumped() Description copied from interface:OptionsThis setting is ignored if suppressSmap() istrue.- Specified by:
- isSmapDumpedin interface- Options
- Returns:
- trueto write SMAP info for JSR45 debugging to a file.
 
 - 
setSmapDumpedpublic void setSmapDumped(boolean smapDumped) Sets smapDumped flag.- Parameters:
- smapDumped- New value
- See Also:
- Options.isSmapDumped()
 
 - 
setGenStringAsCharArraypublic void setGenStringAsCharArray(boolean genStringAsCharArray) Determines whether text strings are to be generated as char arrays, which improves performance in some cases.- Parameters:
- genStringAsCharArray- true if text strings are to be generated as char arrays, false otherwise
 
 - 
genStringAsCharArraypublic boolean genStringAsCharArray() Description copied from interface:OptionsIndicates whether text strings are to be generated as char arrays.- Specified by:
- genStringAsCharArrayin interface- Options
- Returns:
- trueif text strings are to be generated as char arrays,- falseotherwise
 
 - 
setIeClassId@Deprecated public void setIeClassId(java.lang.String ieClassId) Deprecated.Will be removed in Tomcat 10.1Sets the class-id value to be sent to Internet Explorer when using <jsp:plugin> tags.- Parameters:
- ieClassId- Class-id value
 
 - 
getIeClassId@Deprecated public java.lang.String getIeClassId() Deprecated.Description copied from interface:OptionsGets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.- Specified by:
- getIeClassIdin interface- Options
- Returns:
- Class-id value
 
 - 
getScratchDirpublic java.io.File getScratchDir() - Specified by:
- getScratchDirin interface- Options
- Returns:
- the work folder
 
 - 
getCompilerpublic java.lang.String getCompiler() Description copied from interface:OptionsCompiler to use.If null(the default), the java compiler from Eclipse JDT project, bundled with Tomcat, will be used. Otherwise, thejavactask from Apache Ant will be used to call an external java compiler and the value of this option will be passed to it. See Apache Ant documentation for the possible values.- Specified by:
- getCompilerin interface- Options
- Returns:
- the compiler name
 
 - 
setCompilerpublic void setCompiler(java.lang.String c) Sets the option to determine what compiler to use.- Parameters:
- c- New value
- See Also:
- Options.getCompiler()
 
 - 
getCompilerClassNamepublic java.lang.String getCompilerClassName() - Specified by:
- getCompilerClassNamein interface- Options
- Returns:
- Jasper Java compiler class to use.
 
 - 
getCompilerTargetVMpublic java.lang.String getCompilerTargetVM() - Specified by:
- getCompilerTargetVMin interface- Options
- Returns:
- the compiler target VM, e.g. 1.8.
 
 - 
setCompilerTargetVMpublic void setCompilerTargetVM(java.lang.String vm) Sets the compiler target VM.- Parameters:
- vm- New value
- See Also:
- Options.getCompilerTargetVM()
 
 - 
getCompilerSourceVMpublic java.lang.String getCompilerSourceVM() - Specified by:
- getCompilerSourceVMin interface- Options
- Returns:
- the compiler source VM, e.g. 1.8.
 
 - 
setCompilerSourceVMpublic void setCompilerSourceVM(java.lang.String vm) Sets the compiler source VM.- Parameters:
- vm- New value
- See Also:
- Options.getCompilerSourceVM()
 
 - 
getTldCachepublic TldCache getTldCache() Description copied from interface:OptionsThe cache that maps URIs, resource paths and parsed TLD files for the various tag libraries 'exposed' by the web application. A tag library is 'exposed' either explicitly in web.xml or implicitly via the uri tag in the TLD of a taglib deployed in a jar file (WEB-INF/lib).- Specified by:
- getTldCachein interface- Options
- Returns:
- the instance of the TldLocationsCache for the web-application.
 
 - 
getJavaEncodingpublic java.lang.String getJavaEncoding() Returns the encoding to use for java files. The default is UTF-8.- Specified by:
- getJavaEncodingin interface- Options
- Returns:
- String The encoding
 
 - 
setJavaEncodingpublic void setJavaEncoding(java.lang.String encodingName) Sets the encoding to use for java files.- Parameters:
- encodingName- The name, e.g. "UTF-8"
 
 - 
getForkpublic boolean getFork() Description copied from interface:OptionsThe boolean flag to tell Ant whether to fork JSP page compilations.Is used only when Jasper uses an external java compiler (wrapped through a javacApache Ant task).
 - 
setForkpublic void setFork(boolean fork) 
 - 
getClassPathpublic java.lang.String getClassPath() - Specified by:
- getClassPathin interface- Options
- Returns:
- the classpath used to compile generated Servlets
 
 - 
setClassPathpublic void setClassPath(java.lang.String s) Sets the classpath used while compiling the servlets generated from JSP files- Parameters:
- s- New value
 
 - 
getExtensionspublic java.util.List<java.lang.String> getExtensions() Returns the list of file extensions that are treated as JSP files.- Returns:
- The list of extensions
 
 - 
addExtensionprotected void addExtension(java.lang.String extension) Adds the given file extension to the list of extensions handled as JSP files.- Parameters:
- extension- The extension to add, e.g. "myjsp"
 
 - 
setUrirootpublic void setUriroot(java.lang.String s) Base dir for the webapp. Used to generate class names and resolve includes.- Parameters:
- s- New value
 
 - 
setJspFilespublic void setJspFiles(java.lang.String jspFiles) Parses comma-separated list of JSP files to be processed. If the argument is null, nothing is done.Each file is interpreted relative to uriroot, unless it is absolute, in which case it must start with uriroot. - Parameters:
- jspFiles- Comma-separated list of JSP files to be processed
 
 - 
setCompilepublic void setCompile(boolean b) Sets the compile flag.- Parameters:
- b- Flag value
 
 - 
setVerbosepublic void setVerbose(int level) Sets the verbosity level. The actual number doesn't matter: if it's greater than zero, the verbose flag will be true.- Parameters:
- level- Positive means verbose
 
 - 
setValidateTldpublic void setValidateTld(boolean b) 
 - 
isValidateTldpublic boolean isValidateTld() 
 - 
setValidateXmlpublic void setValidateXml(boolean b) 
 - 
isValidateXmlpublic boolean isValidateXml() 
 - 
setBlockExternalpublic void setBlockExternal(boolean b) 
 - 
isBlockExternalpublic boolean isBlockExternal() 
 - 
setStrictQuoteEscapingpublic void setStrictQuoteEscaping(boolean b) 
 - 
getStrictQuoteEscapingpublic boolean getStrictQuoteEscaping() - Specified by:
- getStrictQuoteEscapingin interface- Options
- Returns:
- trueif the quote escaping required by section JSP.1.6 of the JSP specification should be applied to scriplet expression.
 
 - 
setQuoteAttributeELpublic void setQuoteAttributeEL(boolean b) 
 - 
getQuoteAttributeELpublic boolean getQuoteAttributeEL() - Specified by:
- getQuoteAttributeELin interface- Options
- Returns:
- trueif EL expressions used within attributes should have the quoting rules in JSP.1.6 applied to the expression.
 
 - 
getThreadCountpublic int getThreadCount() 
 - 
setThreadCountpublic void setThreadCount(java.lang.String threadCount) 
 - 
setListErrorspublic void setListErrors(boolean b) 
 - 
setOutputDirpublic void setOutputDir(java.lang.String s) 
 - 
setPackagepublic void setPackage(java.lang.String p) Sets the package name to be used for the generated servlet classes.- Parameters:
- p- New value
 
 - 
setClassNamepublic void setClassName(java.lang.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 ?- Parameters:
- p- New value
 
 - 
setWebXmlFragment@Deprecated public void setWebXmlFragment(java.lang.String s) Deprecated.Will be removed in Tomcat 10. UsesetWebXmlInclude(String)File where we generate a web.xml fragment with the class definitions.- Parameters:
- s- New value
 
 - 
setWebXmlIncludepublic void setWebXmlInclude(java.lang.String s) File where we generate configuration with the class definitions to be included in a web.xml file.- Parameters:
- s- New value
 
 - 
setWebFragmentXmlpublic void setWebFragmentXml(java.lang.String s) File where we generate a complete web-fragment.xml with the class definitions.- Parameters:
- s- New value
 
 - 
setWebXmlpublic void setWebXml(java.lang.String s) File where we generate a complete web.xml with the class definitions.- Parameters:
- s- New value
 
 - 
setWebXmlEncodingpublic void setWebXmlEncoding(java.lang.String encoding) Sets the encoding to be used to read and write web.xml files.If not specified, defaults to UTF-8. - Parameters:
- encoding- Encoding, e.g. "UTF-8".
 
 - 
setAddWebXmlMappingspublic void setAddWebXmlMappings(boolean b) Sets the option to merge generated web.xml fragment into the WEB-INF/web.xml file of the web application that we were processing.- Parameters:
- b-- trueto merge the fragment into the existing web.xml file of the processed web application ({uriroot}/WEB-INF/web.xml),- falseto keep the generated web.xml fragment
 
 - 
setFailOnErrorpublic void setFailOnError(boolean b) Sets the option that throws an exception in case of a compilation error.- Parameters:
- b- New value
 
 - 
getFailOnErrorpublic boolean getFailOnError() - Returns:
- trueif an exception will be thrown in case of a compilation error.
 
 - 
getJspConfigpublic JspConfig getJspConfig() - Specified by:
- getJspConfigin interface- Options
- Returns:
- JSP configuration information specified in web.xml.
 
 - 
getTagPluginManagerpublic TagPluginManager getTagPluginManager() - Specified by:
- getTagPluginManagerin interface- Options
- Returns:
- a Tag Plugin Manager
 
 - 
getGeneratedJavaAddTimestamppublic boolean getGeneratedJavaAddTimestamp() Should the container include the time the file was generated in the comments at the start of a Java file generated from a JSP or tag. Defaults totrue.Hard-coded to falsefor pre-compiled code to enable repeatable builds.- Specified by:
- getGeneratedJavaAddTimestampin interface- Options
- Returns:
- trueto include the timestamp, otherwise don't include it
 
 - 
generateWebMappingpublic void generateWebMapping(java.lang.String file, JspCompilationContext clctxt) throws java.io.IOExceptionAdds servlet declaration and mapping for the JSP page servlet to the generated web.xml fragment.- Parameters:
- file- Context-relative path to the JSP file, e.g.- /index.jsp
- clctxt- Compilation context of the servlet
- Throws:
- java.io.IOException- An IO error occurred
 
 - 
mergeIntoWebXmlprotected void mergeIntoWebXml() throws java.io.IOExceptionInclude the generated web.xml inside the webapp's web.xml.- Throws:
- java.io.IOException- An IO error occurred
 
 - 
processFileprotected void processFile(java.lang.String file) throws JasperException- Throws:
- JasperException
 
 - 
scanFiles@Deprecated public void scanFiles(java.io.File base) Deprecated.This will be removed in Tomcat 10. UsescanFiles()Locate all jsp files in the webapp. Used if no explicit jsps are specified.- Parameters:
- base- Base path
 
 - 
scanFilespublic void scanFiles() Locate all jsp files in the webapp. Used if no explicit jsps are specified. Scan is performed via the ServletContext and will include any JSPs located in resource JARs.
 - 
executepublic void execute() Executes the compilation.- Overrides:
- executein class- org.apache.tools.ant.Task
 
 - 
nextArgprotected java.lang.String nextArg() 
 - 
nextFileprotected java.lang.String nextFile() 
 - 
initWebXmlprotected void initWebXml() throws JasperException- Throws:
- JasperException
 
 - 
completeWebXmlprotected void completeWebXml() 
 - 
initTldScannerprotected void initTldScanner(JspCServletContext context, java.lang.ClassLoader classLoader) 
 - 
newTldScannerprotected TldScanner newTldScanner(JspCServletContext context, boolean namespaceAware, boolean validate, boolean blockExternal) 
 - 
initServletContextprotected void initServletContext(java.lang.ClassLoader classLoader) throws java.io.IOException, JasperException- Throws:
- java.io.IOException
- JasperException
 
 - 
initClassLoaderprotected java.lang.ClassLoader initClassLoader() throws java.io.IOExceptionInitializes the classloader as/if needed for the given compilation context.- Returns:
- the classloader that will be used
- Throws:
- java.io.IOException- If an error occurs
 
 - 
locateUriRootprotected void locateUriRoot(java.io.File f) Find the WEB-INF dir by looking up in the directory tree. This is used if no explicit docbase is set, but only files.- Parameters:
- f- The path from which it will start looking
 
 - 
resolveFileprotected java.io.File resolveFile(java.lang.String s) Resolves the relative or absolute pathname correctly in both Ant and command-line situations. If Ant launched us, we should use the basedir of the current project to resolve relative paths. See Bugzilla 35571.- Parameters:
- s- The file
- Returns:
- The file resolved
 
 
- 
 
-