Author: kkolinko
Date: Thu Feb 25 07:13:03 2010
New Revision: 916160
URL: http://svn.apache.org/viewvc?rev=916160&view=rev
Log:
updated the JavaDoc
(merged r916141)
Modified:
tomcat/tc6.0.x/trunk/ (props changed)
tomcat/tc6.0.x/trunk/java/org/apache/jasper/JspC.java
tomcat/tc6.0.x/trunk/java/org/apache/jasper/Options.java
Propchange: tomcat/tc6.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Thu Feb 25 07:13:03 2010
@@ -1,2 +1,2 @@
/tomcat:883362
-/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77
0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901
39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909875,909887,910442,910471,915226
+/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77
0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901
39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909875,909887,910442,910471,915226,916141
Modified: tomcat/tc6.0.x/trunk/java/org/apache/jasper/JspC.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/jasper/JspC.java?rev=916160&r1=916159&r2=916160&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/jasper/JspC.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/jasper/JspC.java Thu Feb 25 07:13:03
2010
@@ -64,20 +64,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"
@@ -251,6 +248,12 @@
}
}
+ /**
+ * Apply command-line arguments.
+ *
+ * @param arg
+ * The arguments
+ */
public void setArgs(String[] arg) throws JasperException {
args = arg;
String tok;
@@ -357,43 +360,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;
}
@@ -403,7 +439,7 @@
}
/**
- * Are we supporting HTML mapped servlets?
+ * {...@inheritdoc}
*/
public boolean getMappedFile() {
return mappedFile;
@@ -422,23 +458,31 @@
return true;
}
+ /**
+ * 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) {
@@ -446,57 +490,61 @@
}
/**
- * @see Options#getCache()
+ * {...@inheritdoc}
*/
public Map 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 debuggin 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;
@@ -515,10 +563,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;
@@ -526,24 +571,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;
}
@@ -559,48 +605,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;
}
@@ -625,16 +686,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;
}
@@ -666,7 +737,7 @@
}
/**
- * Sets the project.
+ * Sets the Ant project.
*
* @param theProject The project
*/
@@ -675,7 +746,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
@@ -686,7 +757,7 @@
/**
* Base dir for the webapp. Used to generate class names and resolve
- * includes
+ * includes.
*/
public void setUriroot( String s ) {
if( s==null ) {
@@ -760,6 +831,9 @@
}
}
+ /**
+ * Sets the package name to be used for the generated servlet classes.
+ */
public void setPackage( String p ) {
targetPackage=p;
}
@@ -789,32 +863,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 informantion 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/tc6.0.x/trunk/java/org/apache/jasper/Options.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/jasper/Options.java?rev=916160&r1=916159&r2=916160&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/jasper/Options.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/jasper/Options.java Thu Feb 25
07:13:03 2010
@@ -91,7 +91,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();
@@ -101,7 +101,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();
@@ -118,21 +121,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();
@@ -156,7 +166,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();
@@ -176,7 +190,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();
@@ -191,11 +208,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 getCache();
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
