Author: kkolinko
Date: Thu Feb 25 06:05:55 2010
New Revision: 916141
URL: http://svn.apache.org/viewvc?rev=916141&view=rev
Log:
updated the JavaDoc
Modified:
tomcat/trunk/java/org/apache/jasper/JspC.java
tomcat/trunk/java/org/apache/jasper/Options.java
Modified: tomcat/trunk/java/org/apache/jasper/JspC.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/jasper/JspC.java?rev=916141&r1=916140&r2=916141&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/jasper/JspC.java (original)
+++ tomcat/trunk/java/org/apache/jasper/JspC.java Thu Feb 25 06:05:55 2010
@@ -70,20 +70,17 @@
*
* It can be used as an Ant task using:
* <pre>
- * <taskdef classname="org.apache.jasper.JspC" name="jasper2" >
+ * <taskdef classname="org.apache.jasper.JspC" name="jasper" >
* <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">
+ * <fileset dir="${ENV.CATALINA_HOME}/lib">
* <include name="*.jar"/>
* </fileset>
* <path refid="myjars"/>
* </classpath>
* </taskdef>
*
- * <jasper2 verbose="0"
+ * <jasper verbose="0"
* package="my.package"
* uriroot="${webapps.dir}/${webapp.name}"
* webXmlFragment="${build.dir}/generated_web.xml"
@@ -269,6 +266,12 @@
}
}
+ /**
+ * Apply command-line arguments.
+ *
+ * @param arg
+ * The arguments
+ */
public void setArgs(String[] arg) throws JasperException {
args = arg;
String tok;
@@ -375,43 +378,76 @@
}
}
+ /**
+ * In JspC this always returns <code>true</code>.
+ * {...@inheritdoc}
+ */
public boolean getKeepGenerated() {
// isn't this why we are running jspc?
return true;
}
+ /**
+ * {...@inheritdoc}
+ */
public boolean getTrimSpaces() {
return trimSpaces;
}
+ /**
+ * Sets the option to trim white spaces between directives or actions.
+ */
public void setTrimSpaces(boolean ts) {
this.trimSpaces = ts;
}
+ /**
+ * {...@inheritdoc}
+ */
public boolean isPoolingEnabled() {
return poolingEnabled;
}
+ /**
+ * Sets the option to enable the tag handler pooling.
+ */
public void setPoolingEnabled(boolean poolingEnabled) {
this.poolingEnabled = poolingEnabled;
}
+ /**
+ * {...@inheritdoc}
+ */
public boolean isXpoweredBy() {
return xpoweredBy;
}
+ /**
+ * Sets the option to enable generation of X-Powered-By response header.
+ */
public void setXpoweredBy(boolean xpoweredBy) {
this.xpoweredBy = xpoweredBy;
}
+ /**
+ * In JspC this always returns <code>true</code>.
+ * {...@inheritdoc}
+ */
public boolean getDisplaySourceFragment() {
return true;
}
-
+
+ /**
+ * {...@inheritdoc}
+ */
public boolean getErrorOnUseBeanInvalidClassAttribute() {
return errorOnUseBeanInvalidClassAttribute;
}
+ /**
+ * Sets the option to issue a compilation error if the class attribute
+ * specified in useBean action is invalid.
+ */
public void setErrorOnUseBeanInvalidClassAttribute(boolean b) {
errorOnUseBeanInvalidClassAttribute = b;
}
@@ -421,7 +457,7 @@
}
/**
- * Are we supporting HTML mapped servlets?
+ * {...@inheritdoc}
*/
public boolean getMappedFile() {
return mappedFile;
@@ -432,23 +468,31 @@
return null;
}
+ /**
+ * Sets the option to include debug information in compiled class.
+ */
public void setClassDebugInfo( boolean b ) {
classDebugInfo=b;
}
+ /**
+ * {...@inheritdoc}
+ */
public boolean getClassDebugInfo() {
// compile with debug info
return classDebugInfo;
}
- /**
- * @see Options#isCaching()
+ /**
+ * {...@inheritdoc}
*/
public boolean isCaching() {
return caching;
}
/**
+ * Sets the option to enable caching.
+ *
* @see Options#isCaching()
*/
public void setCaching(boolean caching) {
@@ -456,57 +500,61 @@
}
/**
- * @see Options#getCache()
+ * {...@inheritdoc}
*/
public Map<String, TagLibraryInfo> getCache() {
return cache;
}
/**
- * Background compilation check intervals in seconds
+ * In JspC this always returns <code>0</code>.
+ * {...@inheritdoc}
*/
public int getCheckInterval() {
return 0;
}
/**
- * Modification test interval.
+ * In JspC this always returns <code>0</code>.
+ * {...@inheritdoc}
*/
public int getModificationTestInterval() {
return 0;
}
/**
- * Is Jasper being used in development mode?
+ * In JspC this always returns <code>false</code>.
+ * {...@inheritdoc}
*/
public boolean getDevelopment() {
return false;
}
/**
- * Is the generation of SMAP info for JSR45 debugging suppressed?
+ * {...@inheritdoc}
*/
public boolean isSmapSuppressed() {
return smapSuppressed;
}
/**
- * Set smapSuppressed flag.
+ * Sets smapSuppressed flag.
*/
public void setSmapSuppressed(boolean smapSuppressed) {
this.smapSuppressed = smapSuppressed;
}
-
/**
- * Should SMAP info for JSR45 debugging be dumped to a file?
+ * {...@inheritdoc}
*/
public boolean isSmapDumped() {
return smapDumped;
}
/**
- * Set smapSuppressed flag.
+ * Sets smapDumped flag.
+ *
+ * @see Options#isSmapDumped()
*/
public void setSmapDumped(boolean smapDumped) {
this.smapDumped = smapDumped;
@@ -525,10 +573,7 @@
}
/**
- * Indicates whether text strings are to be generated as char arrays.
- *
- * @return true if text strings are to be generated as char arrays, false
- * otherwise
+ * {...@inheritdoc}
*/
public boolean genStringAsCharArray() {
return genStringAsCharArray;
@@ -536,24 +581,25 @@
/**
* Sets the class-id value to be sent to Internet Explorer when using
- * <jsp:plugin> tags.
- *
- * @param ieClassId Class-id value
+ * <jsp:plugin> tags.
+ *
+ * @param ieClassId
+ * Class-id value
*/
public void setIeClassId(String ieClassId) {
this.ieClassId = ieClassId;
}
/**
- * Gets the class-id value that is sent to Internet Explorer when using
- * <jsp:plugin> tags.
- *
- * @return Class-id value
+ * {...@inheritdoc}
*/
public String getIeClassId() {
return ieClassId;
}
+ /**
+ * {...@inheritdoc}
+ */
public File getScratchDir() {
return scratchDir;
}
@@ -569,48 +615,63 @@
}
/**
- * Compiler to use.
+ * {...@inheritdoc}
*/
public String getCompiler() {
return compiler;
}
+ /**
+ * Sets the option to determine what compiler to use.
+ *
+ * @see Options#getCompiler()
+ */
public void setCompiler(String c) {
compiler=c;
}
/**
- * Compiler class name to use.
+ * {...@inheritdoc}
*/
public String getCompilerClassName() {
return null;
}
-
+
/**
- * @see Options#getCompilerTargetVM
+ * {...@inheritdoc}
*/
public String getCompilerTargetVM() {
return compilerTargetVM;
}
+ /**
+ * Sets the compiler target VM.
+ *
+ * @see Options#getCompilerTargetVM()
+ */
public void setCompilerTargetVM(String vm) {
compilerTargetVM = vm;
}
/**
- * @see Options#getCompilerSourceVM()
+ * {...@inheritdoc}
*/
public String getCompilerSourceVM() {
return compilerSourceVM;
}
-
- /**
- * @see Options#getCompilerSourceVM()
- */
+
+ /**
+ * Sets the compiler source VM.
+ *
+ * @see Options#getCompilerSourceVM()
+ */
public void setCompilerSourceVM(String vm) {
compilerSourceVM = vm;
}
+ /**
+ * {...@inheritdoc}
+ */
public TldLocationsCache getTldLocationsCache() {
return tldLocationsCache;
}
@@ -635,16 +696,26 @@
javaEncoding = encodingName;
}
+ /**
+ * {...@inheritdoc}
+ */
public boolean getFork() {
return false;
}
+ /**
+ * {...@inheritdoc}
+ */
public String getClassPath() {
if( classPath != null )
return classPath;
return System.getProperty("java.class.path");
}
+ /**
+ * Sets the classpath used while compiling the servlets generated from JSP
+ * files
+ */
public void setClassPath(String s) {
classPath=s;
}
@@ -676,7 +747,7 @@
}
/**
- * Sets the project.
+ * Sets the Ant project.
*
* @param theProject The project
*/
@@ -685,7 +756,7 @@
}
/**
- * Returns the project: may be null if not running
+ * Returns the project: may be <code>null</code> if not running
* inside an Ant project.
*
* @return The project
@@ -696,7 +767,7 @@
/**
* Base dir for the webapp. Used to generate class names and resolve
- * includes
+ * includes.
*/
public void setUriroot( String s ) {
if( s==null ) {
@@ -770,6 +841,9 @@
}
}
+ /**
+ * Sets the package name to be used for the generated servlet classes.
+ */
public void setPackage( String p ) {
targetPackage=p;
}
@@ -799,32 +873,59 @@
webxmlLevel=ALL_WEBXML;
}
+ /**
+ * Sets the option to merge generated web.xml fragment into the
+ * WEB-INF/web.xml file of the web application that we were processing.
+ *
+ * @param b
+ * <code>true</code> to merge the fragment into the existing
+ * web.xml file of the processed web application
+ * ({uriroot}/WEB-INF/web.xml), <code>false</code> to keep the
+ * generated web.xml fragment
+ */
public void setAddWebXmlMappings(boolean b) {
addWebXmlMappings = b;
}
/**
- * Set the option that throws an exception in case of a compilation error.
+ * Sets the option that throws an exception in case of a compilation error.
*/
public void setFailOnError(final boolean b) {
failOnError = b;
}
+ /**
+ * Returns true if an exception will be thrown in case of a compilation
+ * error.
+ */
public boolean getFailOnError() {
return failOnError;
}
/**
- * Obtain JSP configuration information specified in web.xml.
+ * {...@inheritdoc}
*/
public JspConfig getJspConfig() {
return jspConfig;
}
+ /**
+ * {...@inheritdoc}
+ */
public TagPluginManager getTagPluginManager() {
return tagPluginManager;
}
+ /**
+ * Adds servlet declaration and mapping for the JSP page servlet to the
+ * generated web.xml fragment.
+ *
+ * @param file
+ * Context-relative path to the JSP file, e.g.
+ * <code>/index.jsp</code>
+ * @param clctxt
+ * Compilation context of the servlet
+ */
public void generateWebMapping( String file, JspCompilationContext clctxt )
throws IOException
{
Modified: tomcat/trunk/java/org/apache/jasper/Options.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/jasper/Options.java?rev=916141&r1=916140&r2=916141&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/jasper/Options.java (original)
+++ tomcat/trunk/java/org/apache/jasper/Options.java Thu Feb 25 06:05:55 2010
@@ -86,7 +86,7 @@
/**
* Indicates whether SMAP info for JSR45 debugging should be dumped to a
* file.
- * Ignored is suppressSmap() is true
+ * Ignored if suppressSmap() is true.
*/
public boolean isSmapDumped();
@@ -96,7 +96,10 @@
public boolean getTrimSpaces();
/**
- * Class ID for use in the plugin tag when the browser is IE.
+ * Gets the class-id value that is sent to Internet Explorer when using
+ * <jsp:plugin> tags.
+ *
+ * @return Class-id value
*/
public String getIeClassId();
@@ -113,21 +116,28 @@
/**
* Compiler to use.
+ *
+ * <p>
+ * If <code>null</code> (the default), the java compiler from Eclipse JDT
+ * project, bundled with Tomcat, will be used. Otherwise, the
+ * <code>javac</code> task 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.
*/
public String getCompiler();
/**
- * The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, or 1.5.
+ * The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, 1.5 or 1.6.
*/
public String getCompilerTargetVM();
/**
- * Compiler source VM, e.g. 1.3, 1.4, or 1.5.
+ * The compiler source VM, e.g. 1.3, 1.4, 1.5 or 1.6.
*/
public String getCompilerSourceVM();
/**
- * Java compiler class to use.
+ * Jasper Java compiler class to use.
*/
public String getCompilerClassName();
@@ -151,7 +161,11 @@
public String getJavaEncoding();
/**
- * boolean flag to tell Ant whether to fork JSP page compilations.
+ * The boolean flag to tell Ant whether to fork JSP page compilations.
+ *
+ * <p>
+ * Is used only when Jasper uses an external java compiler (wrapped through
+ * a <code>javac</code> Apache Ant task).
*/
public boolean getFork();
@@ -171,7 +185,10 @@
public TagPluginManager getTagPluginManager();
/**
- * Are Text strings to be generated as char arrays?
+ * Indicates whether text strings are to be generated as char arrays.
+ *
+ * @return <code>true</code> if text strings are to be generated as char
+ * arrays, <code>false</code> otherwise
*/
public boolean genStringAsCharArray();
@@ -186,11 +203,15 @@
public boolean isCaching();
/**
- * The web-application wide cache for the returned TreeNode
- * by parseXMLDocument in TagLibraryInfoImpl.parseTLD,
- * if isCaching returns true.
+ * The web-application wide cache for the TagLibraryInfo tag library
+ * descriptors, used if {...@link #isCaching()} returns <code>true</code>.
+ *
+ * <p>
+ * Using this cache avoids the cost of repeating the parsing of a tag
+ * library descriptor XML file (performed by TagLibraryInfoImpl.parseTLD).
+ * </p>
*
- * @return the Map(String uri, TreeNode tld) instance.
+ * @return the Map(String uri, TagLibraryInfo tld) instance.
*/
public Map<String, TagLibraryInfo> getCache();
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
