This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/7.0.x by this push:
new 0359131 Fix various Javadoc warnings/errors with Java 9
0359131 is described below
commit 0359131707e6cb86ee9b7abac8db78eb71a194cb
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Sun Sep 8 23:34:18 2019 +0100
Fix various Javadoc warnings/errors with Java 9
Aligning with 8.5.x where posisble
---
java/javax/servlet/jsp/JspWriter.java | 4 +-
.../javax/servlet/jsp/tagext/SimpleTagSupport.java | 4 +-
java/javax/servlet/jsp/tagext/TagExtraInfo.java | 2 +-
java/org/apache/catalina/Executor.java | 9 +-
java/org/apache/catalina/startup/TldConfig.java | 4 +-
java/org/apache/jasper/compiler/JspUtil.java | 62 ++++++++----
java/org/apache/jasper/compiler/PageDataImpl.java | 7 +-
java/org/apache/jasper/compiler/SmapGenerator.java | 11 ++-
java/org/apache/jasper/compiler/SmapStratum.java | 38 ++++----
.../org/apache/jasper/runtime/BodyContentImpl.java | 74 +++++++++-----
java/org/apache/jasper/runtime/JspWriterImpl.java | 13 ++-
java/org/apache/jasper/tagplugins/jstl/Util.java | 42 +++++---
java/org/apache/jasper/xmlparser/ASCIIReader.java | 2 +-
java/org/apache/jasper/xmlparser/UCSReader.java | 2 +-
java/org/apache/jasper/xmlparser/UTF8Reader.java | 2 +-
java/org/apache/juli/FileHandler.java | 16 ++-
.../tomcat/dbcp/dbcp/DelegatingConnection.java | 8 +-
.../dbcp/dbcp/DelegatingDatabaseMetaData.java | 8 +-
.../tomcat/dbcp/dbcp/DelegatingResultSet.java | 8 +-
.../tomcat/dbcp/dbcp/DelegatingStatement.java | 8 +-
.../dbcp/dbcp/PoolableConnectionFactory.java | 108 ++++++++++-----------
.../apache/tomcat/dbcp/dbcp/PoolingConnection.java | 2 +-
.../dbcp/dbcp/cpdsadapter/DriverAdapterCPDS.java | 2 +-
.../dbcp/cpdsadapter/PooledConnectionImpl.java | 2 +-
.../dbcp/datasources/CPDSConnectionFactory.java | 8 +-
.../dbcp/datasources/InstanceKeyDataSource.java | 14 +--
.../datasources/KeyedCPDSConnectionFactory.java | 8 +-
.../apache/tomcat/dbcp/jocl/ConstructorUtil.java | 20 ++--
.../dbcp/pool/BaseKeyedPoolableObjectFactory.java | 2 +-
.../dbcp/pool/BasePoolableObjectFactory.java | 4 +-
.../dbcp/pool/impl/CursorableLinkedList.java | 74 +++++++-------
.../apache/tomcat/util/codec/binary/Base64.java | 8 +-
.../apache/tomcat/util/digester/CallParamRule.java | 17 +---
.../tomcat/util/digester/ObjectParamRule.java | 8 +-
.../util/digester/WithDefaultsRulesWrapper.java | 3 +-
java/org/apache/tomcat/util/http/ServerCookie.java | 2 +-
java/org/apache/tomcat/util/net/NioChannel.java | 4 +-
.../apache/tomcat/util/net/SecureNioChannel.java | 2 +-
java/org/apache/tomcat/util/net/URL.java | 7 +-
.../tomcat/util/net/jsse/JSSESocketFactory.java | 2 +-
.../tomcat/util/threads/ThreadPoolExecutor.java | 2 +-
41 files changed, 333 insertions(+), 290 deletions(-)
diff --git a/java/javax/servlet/jsp/JspWriter.java
b/java/javax/servlet/jsp/JspWriter.java
index 691f354..9d0be8b 100644
--- a/java/javax/servlet/jsp/JspWriter.java
+++ b/java/javax/servlet/jsp/JspWriter.java
@@ -111,8 +111,8 @@ public abstract class JspWriter extends java.io.Writer {
/**
* Write a line separator. The line separator string is defined by the
- * system property <tt>line.separator</tt>, and is not necessarily a single
- * newline ('\n') character.
+ * system property <code>line.separator</code>, and is not necessarily a
+ * single newline ('\n') character.
*
* @exception IOException
* If an I/O error occurs
diff --git a/java/javax/servlet/jsp/tagext/SimpleTagSupport.java
b/java/javax/servlet/jsp/tagext/SimpleTagSupport.java
index 496ba95..9d9c88f 100644
--- a/java/javax/servlet/jsp/tagext/SimpleTagSupport.java
+++ b/java/javax/servlet/jsp/tagext/SimpleTagSupport.java
@@ -149,8 +149,8 @@ public class SimpleTagSupport implements SimpleTag {
*
* <p> For every instance of TagAdapter
* encountered while traversing the ancestors, the tag handler returned by
- * <tt>TagAdapter.getAdaptee()</tt> - instead of the TagAdapter itself -
- * is compared to <tt>klass</tt>. If the tag handler matches, it - and
+ * <code>TagAdapter.getAdaptee()</code> - instead of the TagAdapter itself
-
+ * is compared to <code>klass</code>. If the tag handler matches, it - and
* not its TagAdapter - is returned.
*
* <p>
diff --git a/java/javax/servlet/jsp/tagext/TagExtraInfo.java
b/java/javax/servlet/jsp/tagext/TagExtraInfo.java
index 027e7c2..1fff9f2 100644
--- a/java/javax/servlet/jsp/tagext/TagExtraInfo.java
+++ b/java/javax/servlet/jsp/tagext/TagExtraInfo.java
@@ -46,7 +46,7 @@ package javax.servlet.jsp.tagext;
* getVariableInfo().
*
* <p>
- * <tt>NOTE:</tt> It is a (translation time) error for a tag definition
+ * <b>NOTE:</b> It is a (translation time) error for a tag definition
* in a TLD with one or more variable subelements to have an associated
* TagExtraInfo implementation that returns a VariableInfo array with
* one or more elements from a call to getVariableInfo().
diff --git a/java/org/apache/catalina/Executor.java
b/java/org/apache/catalina/Executor.java
index 5f323c7..93f984e 100644
--- a/java/org/apache/catalina/Executor.java
+++ b/java/org/apache/catalina/Executor.java
@@ -18,22 +18,25 @@ package org.apache.catalina;
import java.util.concurrent.TimeUnit;
-
public interface Executor extends java.util.concurrent.Executor, Lifecycle {
+
public String getName();
/**
* Executes the given command at some time in the future. The command
* may execute in a new thread, in a pooled thread, or in the calling
- * thread, at the discretion of the <tt>Executor</tt> implementation.
+ * thread, at the discretion of the <code>Executor</code> implementation.
* If no threads are available, it will be added to the work queue.
* If the work queue is full, the system will wait for the specified
* time until it throws a RejectedExecutionException
*
* @param command the runnable task
+ * @param timeout the length of time to wait for the task to complete
+ * @param unit the units in which timeout is expressed
+ *
* @throws java.util.concurrent.RejectedExecutionException if this task
* cannot be accepted for execution - the queue is full
* @throws NullPointerException if command or unit is null
*/
void execute(Runnable command, long timeout, TimeUnit unit);
-}
\ No newline at end of file
+}
diff --git a/java/org/apache/catalina/startup/TldConfig.java
b/java/org/apache/catalina/startup/TldConfig.java
index 9f73fb1..9c0ba24 100644
--- a/java/org/apache/catalina/startup/TldConfig.java
+++ b/java/org/apache/catalina/startup/TldConfig.java
@@ -241,8 +241,8 @@ public final class TldConfig implements LifecycleListener {
* wonderful arrangements present when Tomcat gets embedded.
*
* The set of shared JARs to be scanned for TLDs is narrowed down by
- * the <tt>noTldJars</tt> class variable, which contains the names of JARs
- * that are known not to contain any TLDs.
+ * the <code>noTldJars</code> class variable, which contains the names of
+ * JARs that are known not to contain any TLDs.
*/
@SuppressWarnings("deprecation") //
Context.addApplicationListener(ApplicationListener) is deprecated.
public void execute() {
diff --git a/java/org/apache/jasper/compiler/JspUtil.java
b/java/org/apache/jasper/compiler/JspUtil.java
index f9ee150..553b070 100644
--- a/java/org/apache/jasper/compiler/JspUtil.java
+++ b/java/org/apache/jasper/compiler/JspUtil.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.jasper.compiler;
import java.io.FileNotFoundException;
@@ -64,7 +63,9 @@ public class JspUtil {
public static final int CHUNKSIZE = 1024;
/**
- * Takes a potential expression and converts it into XML form
+ * Takes a potential expression and converts it into XML form.
+ * @param expression The expression to convert
+ * @return XML view
*/
public static String getExprInXml(String expression) {
String returnString;
@@ -109,6 +110,11 @@ public class JspUtil {
* present have valid names. Checks attributes specified as XML-style
* attributes as well as attributes specified using the jsp:attribute
* standard action.
+ * @param typeOfTag The tag type
+ * @param n The corresponding node
+ * @param validAttributes The array with the valid attributes
+ * @param err Dispatcher for errors
+ * @throws JasperException An error occurred
*/
public static void checkAttributes(String typeOfTag, Node n,
ValidAttribute[] validAttributes, ErrorDispatcher err)
@@ -207,6 +213,8 @@ public class JspUtil {
/**
* Escape the 5 entities defined by XML.
+ * @param s String to escape
+ * @return XML escaped string
*/
public static String escapeXml(String s) {
if (s == null) {
@@ -233,8 +241,8 @@ public class JspUtil {
}
/**
- * Replaces any occurrences of the character <tt>replace</tt> with the
- * string <tt>with</tt>.
+ * Replaces any occurrences of the character <code>replace</code> with the
+ * string <code>with</code>.
*/
public static String replace(String name, char replace, String with) {
StringBuilder buf = new StringBuilder();
@@ -295,14 +303,19 @@ public class JspUtil {
}
/**
- * Returns the <tt>Class</tt> object associated with the class or
+ * Returns the <code>Class</code> object associated with the class or
* interface with the given string name.
*
* <p>
- * The <tt>Class</tt> object is determined by passing the given string
- * name to the <tt>Class.forName()</tt> method, unless the given string
+ * The <code>Class</code> object is determined by passing the given string
+ * name to the <code>Class.forName()</code> method, unless the given string
* name represents a primitive type, in which case it is converted to a
- * <tt>Class</tt> object by appending ".class" to it (e.g., "int.class").
+ * <code>Class</code> object by appending ".class" to it (e.g.,
+ * "int.class").
+ * @param type The class name, array or primitive type
+ * @param loader The class loader
+ * @return the loaded class
+ * @throws ClassNotFoundException Loading class failed
*/
public static Class<?> toClass(String type, ClassLoader loader)
throws ClassNotFoundException {
@@ -357,6 +370,8 @@ public class JspUtil {
/**
* Produces a String representing a call to the EL interpreter.
*
+ * @param isTagFile <code>true</code> if the file is a tag file
+ * rather than a JSP
* @param expression
* a String containing zero or more "${}" expressions
* @param expectedType
@@ -707,13 +722,13 @@ public class JspUtil {
* Gets the fully-qualified class name of the tag handler corresponding to
* the given tag file path.
*
- * @param path
- * Tag file path
- * @param err
- * Error dispatcher
+ * @param path Tag file path
+ * @param urn The tag identifier
+ * @param err Error dispatcher
*
* @return Fully-qualified class name of the tag handler corresponding to
* the given tag file path
+ * @throws JasperException Failed to generate a class name for the tag
*/
public static String getTagHandlerClassName(String path, String urn,
ErrorDispatcher err) throws JasperException {
@@ -876,6 +891,8 @@ public class JspUtil {
/**
* Mangle the specified character to create a legal Java class name.
+ * @param ch The character
+ * @return the replacement character as a string
*/
public static final String mangleChar(char ch) {
char[] result = new char[5];
@@ -888,7 +905,9 @@ public class JspUtil {
}
/**
- * Test whether the argument is a Java keyword
+ * Test whether the argument is a Java keyword.
+ * @param key The name
+ * @return <code>true</code> if the name is a java identifier
*/
public static boolean isJavaKeyword(String key) {
int i = 0;
@@ -968,11 +987,12 @@ public class JspUtil {
}
/**
- * Handles taking input from TLDs 'java.lang.Object' ->
- * 'java.lang.Object.class' 'int' -> 'int.class' 'void' -> 'Void.TYPE'
- * 'int[]' -> 'int[].class'
+ * Handles taking input from TLDs 'java.lang.Object' ->
+ * 'java.lang.Object.class' 'int' -> 'int.class' 'void' ->
'Void.TYPE'
+ * 'int[]' -> 'int[].class'
*
- * @param type
+ * @param type The type from the TLD
+ * @return the Java type
*/
public static String toJavaSourceTypeFromTld(String type) {
if (type == null || "void".equals(type)) {
@@ -982,9 +1002,11 @@ public class JspUtil {
}
/**
- * Class.getName() return arrays in the form "[[[<et>", where et, the
- * element type can be one of ZBCDFIJS or L<classname>; It is converted
- * into forms that can be understood by javac.
+ * Class.getName() return arrays in the form "[[[<et>", where et, the
+ * element type can be one of ZBCDFIJS or L<classname>;. It is
+ * converted into forms that can be understood by javac.
+ * @param type the type to convert
+ * @return the equivalent type in Java sources
*/
public static String toJavaSourceType(String type) {
diff --git a/java/org/apache/jasper/compiler/PageDataImpl.java
b/java/org/apache/jasper/compiler/PageDataImpl.java
index bd3dc33..c05b520 100644
--- a/java/org/apache/jasper/compiler/PageDataImpl.java
+++ b/java/org/apache/jasper/compiler/PageDataImpl.java
@@ -29,7 +29,7 @@ import org.xml.sax.Attributes;
import org.xml.sax.helpers.AttributesImpl;
/**
- * An implementation of <tt>javax.servlet.jsp.tagext.PageData</tt> which
+ * An implementation of <code>javax.servlet.jsp.tagext.PageData</code> which
* builds the XML view of a given page.
*
* The XML view is built in two passes:
@@ -59,9 +59,10 @@ class PageDataImpl extends PageData implements TagConstants {
private StringBuilder buf;
/**
- * Constructor.
- *
* @param page the page nodes from which to generate the XML view
+ * @param compiler The compiler for this page
+ *
+ * @throws JasperException If an error occurs
*/
public PageDataImpl(Node.Nodes page, Compiler compiler)
throws JasperException {
diff --git a/java/org/apache/jasper/compiler/SmapGenerator.java
b/java/org/apache/jasper/compiler/SmapGenerator.java
index 13297ed..b2c8698 100644
--- a/java/org/apache/jasper/compiler/SmapGenerator.java
+++ b/java/org/apache/jasper/compiler/SmapGenerator.java
@@ -57,6 +57,7 @@ public class SmapGenerator {
/**
* Sets the filename (without path information) for the generated
* source file. E.g., "foo$jsp.java".
+ * @param x The file name
*/
public synchronized void setOutputFileName(String x) {
outputFileName = x;
@@ -65,13 +66,13 @@ public class SmapGenerator {
/**
* Adds the given SmapStratum object, representing a Stratum with
* logically associated FileSection and LineSection blocks, to
- * the current SmapGenerator. If <tt>default</tt> is true, this
+ * the current SmapGenerator. If <code>defaultStartum</code> is true, this
* stratum is made the default stratum, overriding any previously
* set default.
*
* @param stratum the SmapStratum object to add
- * @param defaultStratum if <tt>true</tt>, this SmapStratum is considered
- * to represent the default SMAP stratum unless
+ * @param defaultStratum if <code>true</code>, this SmapStratum is
+ * considered to represent the default SMAP stratum unless
* overwritten
*/
public synchronized void addStratum(SmapStratum stratum,
@@ -86,7 +87,7 @@ public class SmapGenerator {
*
* @param smap the SMAP to embed
* @param stratumName the name of the stratum output by the compilation
- * that produced the <tt>smap</tt> to be embedded
+ * that produced the <code>smap</code> to be embedded
*/
public synchronized void addSmap(String smap, String stratumName) {
embedded.add("*O " + stratumName + "\n"
@@ -98,7 +99,7 @@ public class SmapGenerator {
* Instructs the SmapGenerator whether to actually print any embedded
* SMAPs or not. Intended for situations without an SMAP resolver.
*
- * @param status If <tt>false</tt>, ignore any embedded SMAPs.
+ * @param status If <code>false</code>, ignore any embedded SMAPs.
*/
public void setDoEmbedded(boolean status) {
doEmbedded = status;
diff --git a/java/org/apache/jasper/compiler/SmapStratum.java
b/java/org/apache/jasper/compiler/SmapStratum.java
index 183d07d..6aa7b5e 100644
--- a/java/org/apache/jasper/compiler/SmapStratum.java
+++ b/java/org/apache/jasper/compiler/SmapStratum.java
@@ -44,14 +44,12 @@ public class SmapStratum {
private int outputLineIncrement = 1;
private boolean lineFileIDSet = false;
- /** Sets InputStartLine. */
public void setInputStartLine(int inputStartLine) {
if (inputStartLine < 0)
throw new IllegalArgumentException("" + inputStartLine);
this.inputStartLine = inputStartLine;
}
- /** Sets OutputStartLine. */
public void setOutputStartLine(int outputStartLine) {
if (outputStartLine < 0)
throw new IllegalArgumentException("" + outputStartLine);
@@ -59,11 +57,13 @@ public class SmapStratum {
}
/**
- * Sets lineFileID. Should be called only when different from
- * that of prior LineInfo object (in any given context) or 0
- * if the current LineInfo has no (logical) predecessor.
- * <tt>LineInfo</tt> will print this file number no matter what.
- */
+ * Sets lineFileID. Should be called only when different from
+ * that of prior LineInfo object (in any given context) or 0
+ * if the current LineInfo has no (logical) predecessor.
+ * <code>LineInfo</code> will print this file number no matter what.
+ *
+ * @param lineFileID The new line file ID
+ */
public void setLineFileID(int lineFileID) {
if (lineFileID < 0)
throw new IllegalArgumentException("" + lineFileID);
@@ -71,14 +71,12 @@ public class SmapStratum {
this.lineFileIDSet = true;
}
- /** Sets InputLineCount. */
public void setInputLineCount(int inputLineCount) {
if (inputLineCount < 0)
throw new IllegalArgumentException("" + inputLineCount);
this.inputLineCount = inputLineCount;
}
- /** Sets OutputLineIncrement. */
public void setOutputLineIncrement(int outputLineIncrement) {
if (outputLineIncrement < 0)
throw new IllegalArgumentException("" + outputLineIncrement);
@@ -86,9 +84,9 @@ public class SmapStratum {
}
/**
- * Retrieves the current LineInfo as a String, print all values
- * only when appropriate (but LineInfoID if and only if it's been
- * specified, as its necessity is sensitive to context).
+ * @return the current LineInfo as a String, print all values only when
+ * appropriate (but LineInfoID if and only if it's been
+ * specified, as its necessity is sensitive to context).
*/
public String getString() {
if (inputStartLine == -1 || outputStartLine == -1)
@@ -229,19 +227,19 @@ public class SmapStratum {
* later.)
*
* @param inputStartLine starting line in the source file
- * (SMAP <tt>InputStartLine</tt>)
+ * (SMAP <code>InputStartLine</code>)
* @param inputFileName the filepath (or name) from which the input comes
- * (yields SMAP <tt>LineFileID</tt>) Use unqualified names
+ * (yields SMAP <code>LineFileID</code>) Use unqualified names
* carefully, and only when they uniquely identify a file.
* @param inputLineCount the number of lines in the input to map
- * (SMAP <tt>LineFileCount</tt>)
+ * (SMAP <code>LineFileCount</code>)
* @param outputStartLine starting line in the output file
- * (SMAP <tt>OutputStartLine</tt>)
+ * (SMAP <code>OutputStartLine</code>)
* @param outputLineIncrement number of output lines to map to each
- * input line (SMAP <tt>OutputLineIncrement</tt>). <i>Given the
+ * input line (SMAP <code>OutputLineIncrement</code>). <i>Given the
* fact that the name starts with "output", I continuously have
* the subconscious urge to call this field
- * <tt>OutputLineExcrement</tt>.</i>
+ * <code>OutputLineExcrement</code>.</i>
*/
public void addLineData(
int inputStartLine,
@@ -281,14 +279,14 @@ public class SmapStratum {
// Methods to retrieve information
/**
- * Returns the name of the stratum.
+ * @return the name of the stratum.
*/
public String getStratumName() {
return stratumName;
}
/**
- * Returns the given stratum as a String: a StratumSection,
+ * @return the given stratum as a String: a StratumSection,
* followed by at least one FileSection and at least one LineSection.
*/
public String getString() {
diff --git a/java/org/apache/jasper/runtime/BodyContentImpl.java
b/java/org/apache/jasper/runtime/BodyContentImpl.java
index 17ca2ad..c1f1d7f 100644
--- a/java/org/apache/jasper/runtime/BodyContentImpl.java
+++ b/java/org/apache/jasper/runtime/BodyContentImpl.java
@@ -85,15 +85,19 @@ public class BodyContentImpl extends BodyContent {
}
}
+
private char[] cb;
private int nextChar;
private boolean closed;
- // Enclosed writer to which any output is written
+ /**
+ * Enclosed writer to which any output is written
+ */
private Writer writer;
/**
* Constructor.
+ * @param enclosingWriter The wrapped writer
*/
public BodyContentImpl(JspWriter enclosingWriter) {
super(enclosingWriter);
@@ -105,6 +109,8 @@ public class BodyContentImpl extends BodyContent {
/**
* Write a single character.
+ * @param c The char to write
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void write(int c) throws IOException {
@@ -133,6 +139,7 @@ public class BodyContentImpl extends BodyContent {
* @param cbuf A character array
* @param off Offset from which to start reading characters
* @param len Number of characters to write
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void write(char[] cbuf, int off, int len) throws IOException {
@@ -159,6 +166,8 @@ public class BodyContentImpl extends BodyContent {
/**
* Write an array of characters. This method cannot be inherited from the
* Writer class because it must suppress I/O exceptions.
+ * @param buf Content to write
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void write(char[] buf) throws IOException {
@@ -175,6 +184,7 @@ public class BodyContentImpl extends BodyContent {
* @param s String to be written
* @param off Offset from which to start reading characters
* @param len Number of characters to be written
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void write(String s, int off, int len) throws IOException {
@@ -193,6 +203,8 @@ public class BodyContentImpl extends BodyContent {
/**
* Write a string. This method cannot be inherited from the Writer class
* because it must suppress I/O exceptions.
+ * @param s String to be written
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void write(String s) throws IOException {
@@ -205,10 +217,10 @@ public class BodyContentImpl extends BodyContent {
/**
* Write a line separator. The line separator string is defined by the
- * system property <tt>line.separator</tt>, and is not necessarily a single
- * newline ('\n') character.
+ * system property <code>line.separator</code>, and is not necessarily a
+ * single newline ('\n') character.
*
- * @throws IOException If an I/O error occurs
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void newLine() throws IOException {
@@ -227,7 +239,7 @@ public class BodyContentImpl extends BodyContent {
* #write(int)}</code> method.
*
* @param b The <code>boolean</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(boolean b) throws IOException {
@@ -245,7 +257,7 @@ public class BodyContentImpl extends BodyContent {
* #write(int)}</code> method.
*
* @param c The <code>char</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(char c) throws IOException {
@@ -264,7 +276,7 @@ public class BodyContentImpl extends BodyContent {
* method.
*
* @param i The <code>int</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(int i) throws IOException {
@@ -283,7 +295,7 @@ public class BodyContentImpl extends BodyContent {
* <code>{@link #write(int)}</code> method.
*
* @param l The <code>long</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(long l) throws IOException {
@@ -302,7 +314,7 @@ public class BodyContentImpl extends BodyContent {
* <code>{@link #write(int)}</code> method.
*
* @param f The <code>float</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(float f) throws IOException {
@@ -321,7 +333,7 @@ public class BodyContentImpl extends BodyContent {
* #write(int)}</code> method.
*
* @param d The <code>double</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(double d) throws IOException {
@@ -341,7 +353,7 @@ public class BodyContentImpl extends BodyContent {
* @param s The array of chars to be printed
*
* @throws NullPointerException If <code>s</code> is <code>null</code>
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(char[] s) throws IOException {
@@ -360,7 +372,7 @@ public class BodyContentImpl extends BodyContent {
* <code>{@link #write(int)}</code> method.
*
* @param s The <code>String</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(String s) throws IOException {
@@ -380,7 +392,7 @@ public class BodyContentImpl extends BodyContent {
* <code>{@link #write(int)}</code> method.
*
* @param obj The <code>Object</code> to be printed
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void print(Object obj) throws IOException {
@@ -397,7 +409,7 @@ public class BodyContentImpl extends BodyContent {
* <code>line.separator</code>, and is not necessarily a single newline
* character (<code>'\n'</code>).
*
- * @throws IOException
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println() throws IOException {
@@ -409,7 +421,8 @@ public class BodyContentImpl extends BodyContent {
* as though it invokes <code>{@link #print(boolean)}</code> and then
* <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The <code>boolean</code> to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(boolean x) throws IOException {
@@ -422,7 +435,8 @@ public class BodyContentImpl extends BodyContent {
* though it invokes <code>{@link #print(char)}</code> and then
* <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The <code>char</code> to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(char x) throws IOException {
@@ -435,7 +449,8 @@ public class BodyContentImpl extends BodyContent {
* though it invokes <code>{@link #print(int)}</code> and then
* <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The <code>int</code> to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(int x) throws IOException {
@@ -448,7 +463,8 @@ public class BodyContentImpl extends BodyContent {
* as though it invokes <code>{@link #print(long)}</code> and then
* <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The <code>long</code> to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(long x) throws IOException {
@@ -461,7 +477,8 @@ public class BodyContentImpl extends BodyContent {
* behaves as though it invokes <code>{@link #print(float)}</code> and then
* <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The <code>float</code> to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(float x) throws IOException {
@@ -474,7 +491,8 @@ public class BodyContentImpl extends BodyContent {
* line. This method behaves as though it invokes <code>{@link
* #print(double)}</code> and then <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The <code>double</code> to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(double x) throws IOException{
@@ -487,7 +505,8 @@ public class BodyContentImpl extends BodyContent {
* behaves as though it invokes <code>{@link #print(char[])}</code> and
* then <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The <code>char</code> array to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(char x[]) throws IOException {
@@ -500,7 +519,8 @@ public class BodyContentImpl extends BodyContent {
* though it invokes <code>{@link #print(String)}</code> and then
* <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The string to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(String x) throws IOException {
@@ -513,7 +533,8 @@ public class BodyContentImpl extends BodyContent {
* though it invokes <code>{@link #print(Object)}</code> and then
* <code>{@link #println()}</code>.
*
- * @throws IOException
+ * @param x The object to be printed
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void println(Object x) throws IOException {
@@ -527,7 +548,7 @@ public class BodyContentImpl extends BodyContent {
* to signal the fact that some data has already been irrevocably
* written to the client response stream.
*
- * @throws IOException If an I/O error occurs
+ * @throws IOException If there is no wrapped writer
*/
@Override
public void clear() throws IOException {
@@ -548,7 +569,7 @@ public class BodyContentImpl extends BodyContent {
* flushed. It merely clears the current content of the buffer and
* returns.
*
- * @throws IOException If an I/O error occurs
+ * @throws IOException Should not happen
*/
@Override
public void clearBuffer() throws IOException {
@@ -562,7 +583,7 @@ public class BodyContentImpl extends BodyContent {
* further write() or flush() invocations will cause an IOException to be
* thrown. Closing a previously-closed stream, however, has no effect.
*
- * @throws IOException If an I/O error occurs
+ * @throws IOException Error writing to wrapped writer
*/
@Override
public void close() throws IOException {
@@ -626,6 +647,7 @@ public class BodyContentImpl extends BodyContent {
*
* @param out The writer into which to place the contents of this body
* evaluation
+ * @throws IOException Error writing to writer
*/
@Override
public void writeOut(Writer out) throws IOException {
diff --git a/java/org/apache/jasper/runtime/JspWriterImpl.java
b/java/org/apache/jasper/runtime/JspWriterImpl.java
index 67c77f7..f80a087 100644
--- a/java/org/apache/jasper/runtime/JspWriterImpl.java
+++ b/java/org/apache/jasper/runtime/JspWriterImpl.java
@@ -71,8 +71,9 @@ public class JspWriterImpl extends JspWriter {
*
* @param response A Servlet Response
* @param sz Output-buffer size, a positive integer
- *
- * @exception IllegalArgumentException If sz is <= 0
+ * @param autoFlush <code>true</code> to automatically flush on buffer
+ * full, <code>false</code> to throw an overflow exception in that case
+ * @exception IllegalArgumentException If sz is <= 0
*/
public JspWriterImpl(ServletResponse response, int sz,
boolean autoFlush) {
@@ -93,7 +94,8 @@ public class JspWriterImpl extends JspWriter {
this.bufferSize=sz;
}
- /** Package-level access
+ /**
+ * Package-level access
*/
void recycle() {
flushed = false;
@@ -107,6 +109,7 @@ public class JspWriterImpl extends JspWriter {
* Flush the output buffer to the underlying character stream, without
* flushing the stream itself. This method is non-private only so that it
* may be invoked by PrintStream.
+ * @throws IOException Error writing buffered data
*/
protected final void flushBuffer() throws IOException {
if (bufferSize == 0)
@@ -344,8 +347,8 @@ public class JspWriterImpl extends JspWriter {
/**
* Write a line separator. The line separator string is defined by the
- * system property <tt>line.separator</tt>, and is not necessarily a single
- * newline ('\n') character.
+ * system property <code>line.separator</code>, and is not necessarily a
+ * single newline ('\n') character.
*
* @exception IOException If an I/O error occurs
*/
diff --git a/java/org/apache/jasper/tagplugins/jstl/Util.java
b/java/org/apache/jasper/tagplugins/jstl/Util.java
index 99b97c8..c5e111a 100644
--- a/java/org/apache/jasper/tagplugins/jstl/Util.java
+++ b/java/org/apache/jasper/tagplugins/jstl/Util.java
@@ -88,9 +88,11 @@ public class Util {
}
/**
- * Returns <tt>true</tt> if our current URL is absolute,
- * <tt>false</tt> otherwise.
+ * Returns <code>true</code> if our current URL is absolute,
+ * <code>false</code> otherwise.
* taken from org.apache.taglibs.standard.tag.common.core.ImportSupport
+ * @param url The URL
+ * @return <code>true</code> if the URL is absolute
*/
public static boolean isAbsoluteUrl(String url){
if(url == null){
@@ -115,6 +117,9 @@ public class Util {
* Get the value associated with a content-type attribute.
* Syntax defined in RFC 2045, section 5.1.
* taken from org.apache.taglibs.standard.tag.common.core.Util
+ * @param input The attribute string
+ * @param name The attribute name
+ * @return the attribute value
*/
public static String getContentTypeAttribute(String input, String name) {
int begin;
@@ -142,12 +147,14 @@ public class Util {
}
/**
- * Strips a servlet session ID from <tt>url</tt>. The session ID
+ * Strips a servlet session ID from <code>url</code>. The session ID
* is encoded as a URL "path parameter" beginning with "jsessionid=".
* We thus remove anything we find between ";jsessionid=" (inclusive)
* and either EOS or a subsequent ';' (exclusive).
*
* taken from org.apache.taglibs.standard.tag.common.core.ImportSupport
+ * @param url The URL
+ * @return the URL without a user submitted session id parameter
*/
public static String stripSession(String url) {
StringBuilder u = new StringBuilder(url);
@@ -168,15 +175,17 @@ public class Util {
* Performs the following substring replacements
* (to facilitate output to XML/HTML pages):
*
- * & -> &
- * < -> <
- * > -> >
- * " -> "
- * ' -> '
+ * & -> &amp;
+ * < -> &lt;
+ * > -> &gt;
+ * " -> &#034;
+ * ' -> &#039;
*
* See also OutSupport.writeEscapedXml().
*
* taken from org.apache.taglibs.standard.tag.common.core.Util
+ * @param buffer Data to escape
+ * @return escaped data
*/
public static String escapeXml(String buffer) {
String result = escapeXml(buffer.toCharArray(), buffer.length());
@@ -222,8 +231,14 @@ public class Util {
return escapedBuffer.toString();
}
- /** Utility methods
+ /**
+ * Utility methods
* taken from org.apache.taglibs.standard.tag.common.core.UrlSupport
+ * @param url The URL
+ * @param context The context
+ * @param pageContext The page context
+ * @return the absolute URL
+ * @throws JspException If the URL doesn't start with '/'
*/
public static String resolveUrl(
String url, String context, PageContext pageContext)
@@ -261,9 +276,9 @@ public class Util {
*/
public static class ImportResponseWrapper extends
HttpServletResponseWrapper{
- private StringWriter sw = new StringWriter();
- private ByteArrayOutputStream bos = new ByteArrayOutputStream();
- private ServletOutputStream sos = new ServletOutputStream() {
+ private final StringWriter sw = new StringWriter();
+ private final ByteArrayOutputStream bos = new ByteArrayOutputStream();
+ private final ServletOutputStream sos = new ServletOutputStream() {
@Override
public void write(int b) throws IOException {
bos.write(b);
@@ -276,7 +291,6 @@ public class Util {
public ImportResponseWrapper(HttpServletResponse arg0) {
super(arg0);
- // TODO Auto-generated constructor stub
}
@Override
@@ -297,13 +311,11 @@ public class Util {
return sos;
}
- /** Has no effect. */
@Override
public void setContentType(String x) {
// ignore
}
- /** Has no effect. */
@Override
public void setLocale(Locale x) {
// ignore
diff --git a/java/org/apache/jasper/xmlparser/ASCIIReader.java
b/java/org/apache/jasper/xmlparser/ASCIIReader.java
index 86c1794..3de79a0 100644
--- a/java/org/apache/jasper/xmlparser/ASCIIReader.java
+++ b/java/org/apache/jasper/xmlparser/ASCIIReader.java
@@ -69,7 +69,7 @@ public class ASCIIReader extends Reader {
* should override this method.
*
* @return The character read, as an integer in the range 0 to 127
- * (<tt>0x00-0x7f</tt>), or -1 if the end of the stream has
+ * (<code>0x00-0x7f</code>), or -1 if the end of the stream has
* been reached
*
* @exception IOException If an I/O error occurs
diff --git a/java/org/apache/jasper/xmlparser/UCSReader.java
b/java/org/apache/jasper/xmlparser/UCSReader.java
index 3a5510e..dde1536 100644
--- a/java/org/apache/jasper/xmlparser/UCSReader.java
+++ b/java/org/apache/jasper/xmlparser/UCSReader.java
@@ -103,7 +103,7 @@ public class UCSReader extends Reader {
* should override this method.
*
* @return The character read, as an integer in the range 0 to 127
- * (<tt>0x00-0x7f</tt>), or -1 if the end of the stream has
+ * (<code>0x00-0x7f</code>), or -1 if the end of the stream has
* been reached
*
* @exception IOException If an I/O error occurs
diff --git a/java/org/apache/jasper/xmlparser/UTF8Reader.java
b/java/org/apache/jasper/xmlparser/UTF8Reader.java
index 824b264..6f8f642 100644
--- a/java/org/apache/jasper/xmlparser/UTF8Reader.java
+++ b/java/org/apache/jasper/xmlparser/UTF8Reader.java
@@ -82,7 +82,7 @@ public class UTF8Reader
* should override this method.
*
* @return The character read, as an integer in the range 0 to 16383
- * (<tt>0x00-0xffff</tt>), or -1 if the end of the stream has
+ * (<code>0x00-0xffff</code>), or -1 if the end of the stream
has
* been reached
*
* @exception IOException If an I/O error occurs
diff --git a/java/org/apache/juli/FileHandler.java
b/java/org/apache/juli/FileHandler.java
index a10699c..fde18a2 100644
--- a/java/org/apache/juli/FileHandler.java
+++ b/java/org/apache/juli/FileHandler.java
@@ -87,10 +87,10 @@ import java.util.regex.Pattern;
* <li><code>formatter</code> - The <code>java.util.logging.Formatter</code>
* implementation class name for this Handler. Default value:
* <code>java.util.logging.SimpleFormatter</code></li>
- * <li><code>maxDays</code> - The maximum number of days to keep the log
files.
- * If the specified value is <code><=0</code> then the log files will be
kept
- * on the file system forever, otherwise they will be kept the specified
maximum
- * days. Default value: <code>-1</code>.</li>
+ * <li><code>maxDays</code> - The maximum number of days to keep the log
+ * files. If the specified value is <code><=0</code> then the log files
+ * will be kept on the file system forever, otherwise they will be kept the
+ * specified maximum days. Default value: <code>-1</code>.</li>
* </ul>
*/
public class FileHandler extends Handler {
@@ -232,8 +232,8 @@ public class FileHandler extends Handler {
/**
- * Represents a file name pattern of type {prefix}{date}{suffix}. The date
- * is YYYY-MM-DD
+ * Represents a file name pattern of type {prefix}{date}{suffix}.
+ * The date is YYYY-MM-DD
*/
private Pattern pattern;
@@ -242,7 +242,7 @@ public class FileHandler extends Handler {
/**
- * Format and publish a <tt>LogRecord</tt>.
+ * Format and publish a <code>LogRecord</code>.
*
* @param record description of the log event
*/
@@ -300,7 +300,6 @@ public class FileHandler extends Handler {
}
} catch (Exception e) {
reportError(null, e, ErrorManager.WRITE_FAILURE);
- return;
}
} finally {
writerLock.readLock().unlock();
@@ -449,7 +448,6 @@ public class FileHandler extends Handler {
// Set error manager
setErrorManager(new ErrorManager());
-
}
diff --git a/java/org/apache/tomcat/dbcp/dbcp/DelegatingConnection.java
b/java/org/apache/tomcat/dbcp/dbcp/DelegatingConnection.java
index 890863d..33308fd 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/DelegatingConnection.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/DelegatingConnection.java
@@ -206,17 +206,17 @@ public class DelegatingConnection extends AbandonedTrace
/**
* If my underlying {@link Connection} is not a
- * <tt>DelegatingConnection</tt>, returns it,
+ * <code>DelegatingConnection</code>, returns it,
* otherwise recursively invokes this method on
* my delegate.
* <p>
* Hence this method will return the first
- * delegate that is not a <tt>DelegatingConnection</tt>,
- * or <tt>null</tt> when no non-<tt>DelegatingConnection</tt>
+ * delegate that is not a <code>DelegatingConnection</code>,
+ * or <code>null</code> when no non-<code>DelegatingConnection</code>
* delegate can be found by traversing this chain.
* <p>
* This method is useful when you may have nested
- * <tt>DelegatingConnection</tt>s, and you want to make
+ * <code>DelegatingConnection</code>s, and you want to make
* sure to obtain a "genuine" {@link Connection}.
*
* @return The first delegate that is not a {@link DelegatingConnection},
or {@code null}.
diff --git a/java/org/apache/tomcat/dbcp/dbcp/DelegatingDatabaseMetaData.java
b/java/org/apache/tomcat/dbcp/dbcp/DelegatingDatabaseMetaData.java
index 51c2532..8142f7d 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/DelegatingDatabaseMetaData.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/DelegatingDatabaseMetaData.java
@@ -82,17 +82,17 @@ public class DelegatingDatabaseMetaData extends
AbandonedTrace
/**
* If my underlying {@link ResultSet} is not a
- * <tt>DelegatingResultSet</tt>, returns it,
+ * <code>DelegatingResultSet</code>, returns it,
* otherwise recursively invokes this method on
* my delegate.
* <p>
* Hence this method will return the first
- * delegate that is not a <tt>DelegatingResultSet</tt>,
- * or <tt>null</tt> when no non-<tt>DelegatingResultSet</tt>
+ * delegate that is not a <code>DelegatingResultSet</code>,
+ * or <code>null</code> when no non-<code>DelegatingResultSet</code>
* delegate can be found by transversing this chain.
* <p>
* This method is useful when you may have nested
- * <tt>DelegatingResultSet</tt>s, and you want to make
+ * <code>DelegatingResultSet</code>s, and you want to make
* sure to obtain a "genuine" {@link ResultSet}.
*/
public DatabaseMetaData getInnermostDelegate() {
diff --git a/java/org/apache/tomcat/dbcp/dbcp/DelegatingResultSet.java
b/java/org/apache/tomcat/dbcp/dbcp/DelegatingResultSet.java
index 66fe959..75fab36 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/DelegatingResultSet.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/DelegatingResultSet.java
@@ -144,17 +144,17 @@ public class DelegatingResultSet extends AbandonedTrace
implements ResultSet {
/**
* If my underlying {@link ResultSet} is not a
- * <tt>DelegatingResultSet</tt>, returns it,
+ * <code>DelegatingResultSet</code>, returns it,
* otherwise recursively invokes this method on
* my delegate.
* <p>
* Hence this method will return the first
- * delegate that is not a <tt>DelegatingResultSet</tt>,
- * or <tt>null</tt> when no non-<tt>DelegatingResultSet</tt>
+ * delegate that is not a <code>DelegatingResultSet</code>,
+ * or <code>null</code> when no non-<code>DelegatingResultSet</code>
* delegate can be found by transversing this chain.
* <p>
* This method is useful when you may have nested
- * <tt>DelegatingResultSet</tt>s, and you want to make
+ * <code>DelegatingResultSet</code>s, and you want to make
* sure to obtain a "genuine" {@link ResultSet}.
*/
public ResultSet getInnermostDelegate() {
diff --git a/java/org/apache/tomcat/dbcp/dbcp/DelegatingStatement.java
b/java/org/apache/tomcat/dbcp/dbcp/DelegatingStatement.java
index 8e1969e..f7c30cc 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/DelegatingStatement.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/DelegatingStatement.java
@@ -110,17 +110,17 @@ public class DelegatingStatement extends AbandonedTrace
implements Statement {
/**
* If my underlying {@link Statement} is not a
- * <tt>DelegatingStatement</tt>, returns it,
+ * <code>DelegatingStatement</code>, returns it,
* otherwise recursively invokes this method on
* my delegate.
* <p>
* Hence this method will return the first
- * delegate that is not a <tt>DelegatingStatement</tt>
- * or <tt>null</tt> when no non-<tt>DelegatingStatement</tt>
+ * delegate that is not a <code>DelegatingStatement</code>
+ * or <code>null</code> when no non-<code>DelegatingStatement</code>
* delegate can be found by transversing this chain.
* <p>
* This method is useful when you may have nested
- * <tt>DelegatingStatement</tt>s, and you want to make
+ * <code>DelegatingStatement</code>s, and you want to make
* sure to obtain a "genuine" {@link Statement}.
* @see #getDelegate
*/
diff --git a/java/org/apache/tomcat/dbcp/dbcp/PoolableConnectionFactory.java
b/java/org/apache/tomcat/dbcp/dbcp/PoolableConnectionFactory.java
index 20318f2..b04fa6f 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/PoolableConnectionFactory.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/PoolableConnectionFactory.java
@@ -40,11 +40,11 @@ import org.apache.tomcat.dbcp.pool.ObjectPool;
*/
public class PoolableConnectionFactory implements
PoolableObjectFactory<PoolableConnection> {
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
*/
@@ -61,12 +61,12 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
- * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <tt>null</tt> turns off initialization.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
+ * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <code>null</code> turns off initialization.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @since 1.3
@@ -85,11 +85,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param validationQueryTimeout the number of seconds that validation
queries will wait for database response before failing. Use a value less than
or equal to 0 for no timeout.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
@@ -109,13 +109,13 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param validationQueryTimeout the number of seconds that validation
queries will wait for database response before failing. Use a value less than
or equal to 0 for no timeout.
- * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <tt>null</tt> turns off initialization.
+ * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <code>null</code> turns off initialization.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @since 1.3
@@ -135,11 +135,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -158,12 +158,12 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
- * @param connectionInitSqls a Collection of SQL statement to initialize
{@link Connection}s. Using <tt>null</tt> turns off initialization.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
+ * @param connectionInitSqls a Collection of SQL statement to initialize
{@link Connection}s. Using <code>null</code> turns off initialization.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -184,11 +184,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param validationQueryTimeout the number of seconds that validation
queries will wait for database response before failing. Use a value less than
or equal to 0 for no timeout.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
@@ -210,13 +210,13 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param validationQueryTimeout the number of seconds that validation
queries will wait for database response before failing. Use a value less than
or equal to 0 for no timeout.
- * @param connectionInitSqls a Collection of SQL statement to initialize
{@link Connection}s. Using <tt>null</tt> turns off initialization.
+ * @param connectionInitSqls a Collection of SQL statement to initialize
{@link Connection}s. Using <code>null</code> turns off initialization.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -238,11 +238,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param config the AbandonedConfig if tracing SQL objects
@@ -267,11 +267,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -299,11 +299,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -334,11 +334,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -369,12 +369,12 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
- * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <tt>null</tt> turns off initialization.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
+ * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <code>null</code> turns off initialization.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -408,11 +408,11 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param validationQueryTimeout the number of seconds that validation
queries will wait for database response before failing. Use a value less than
or equal to 0 for no timeout.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
@@ -447,13 +447,13 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
* @param connFactory the {@link ConnectionFactory} from which to obtain
base {@link Connection}s
* @param pool the {@link ObjectPool} in which to pool those {@link
Connection}s
- * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
+ * @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link
java.sql.PreparedStatement}s, or <code>null</code> to disable {@link
java.sql.PreparedStatement} pooling
+ * @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s. Should return at least one row. Using
<code>null</code> turns off validation.
* @param validationQueryTimeout the number of seconds that validation
queries will wait for database response before failing. Use a value less than
or equal to 0 for no timeout.
- * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <tt>null</tt> turns off initialization.
+ * @param connectionInitSqls a Collection of SQL statements to initialize
{@link Connection}s. Using <code>null</code> turns off initialization.
* @param defaultReadOnly the default "read only" setting for borrowed
{@link Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
{@link Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned {@link Connection}s
@@ -499,7 +499,7 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
/**
* Sets the query I use to {@link #validateObject validate} {@link
Connection}s.
* Should return at least one row.
- * Using <tt>null</tt> turns off validation.
+ * Using <code>null</code> turns off validation.
* @param validationQuery a query to use to {@link #validateObject
validate} {@link Connection}s.
*/
public void setValidationQuery(String validationQuery) {
@@ -521,7 +521,7 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
/**
* Sets the SQL statements I use to initialize newly created {@link
Connection}s.
- * Using <tt>null</tt> turns off connection initialization.
+ * Using <code>null</code> turns off connection initialization.
* @param connectionInitSqls SQL statement to initialize {@link
Connection}s.
* @since 1.3
*/
@@ -555,7 +555,7 @@ public class PoolableConnectionFactory implements
PoolableObjectFactory<Poolable
/**
* Sets the {@link KeyedObjectPoolFactory} I use to create {@link
KeyedObjectPool}s
* for pooling {@link java.sql.PreparedStatement}s.
- * Set to <tt>null</tt> to disable {@link java.sql.PreparedStatement}
pooling.
+ * Set to <code>null</code> to disable {@link java.sql.PreparedStatement}
pooling.
* @param stmtPoolFactory the {@link KeyedObjectPoolFactory} to use to
create {@link KeyedObjectPool}s for pooling {@link java.sql.PreparedStatement}s
*/
public void setStatementPoolFactory(KeyedObjectPoolFactory<PStmtKey,
DelegatingPreparedStatement> stmtPoolFactory) {
diff --git a/java/org/apache/tomcat/dbcp/dbcp/PoolingConnection.java
b/java/org/apache/tomcat/dbcp/dbcp/PoolingConnection.java
index 3efaa96..5fe67fb 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/PoolingConnection.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/PoolingConnection.java
@@ -442,7 +442,7 @@ public class PoolingConnection extends DelegatingConnection
*
* @param key ignored
* @param obj ignored
- * @return <tt>true</tt>
+ * @return <code>true</code>
*/
@Override
public boolean validateObject(PStmtKey key, DelegatingPreparedStatement
obj) {
diff --git
a/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/DriverAdapterCPDS.java
b/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/DriverAdapterCPDS.java
index 3eaf90f..c987e1d 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/DriverAdapterCPDS.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/DriverAdapterCPDS.java
@@ -647,7 +647,7 @@ public class DriverAdapterCPDS
* Sets the number of statements to examine during each run of the
* idle object evictor thread (if any).
* <p>
- * When a negative value is supplied, <tt>ceil({*link
#numIdle})/abs({*link #getNumTestsPerEvictionRun})</tt>
+ * When a negative value is supplied, <code>ceil({*link
#numIdle})/abs({*link #getNumTestsPerEvictionRun})</code>
* tests will be run. I.e., when the value is <i>-n</i>, roughly one
<i>n</i>th of the
* idle objects will be tested per run.
*
diff --git
a/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/PooledConnectionImpl.java
b/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/PooledConnectionImpl.java
index 0232991..be4debe 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/PooledConnectionImpl.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/cpdsadapter/PooledConnectionImpl.java
@@ -471,7 +471,7 @@ class PooledConnectionImpl
* {*link PreparedStatement}s.
* @param key ignored
* @param obj ignored
- * @return <tt>true</tt>
+ * @return <code>true</code>
*/
@Override
public boolean validateObject(PStmtKey key, DelegatingPreparedStatement
obj) {
diff --git
a/java/org/apache/tomcat/dbcp/dbcp/datasources/CPDSConnectionFactory.java
b/java/org/apache/tomcat/dbcp/dbcp/datasources/CPDSConnectionFactory.java
index 47bc497..152c1fb 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/datasources/CPDSConnectionFactory.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/datasources/CPDSConnectionFactory.java
@@ -66,7 +66,7 @@ class CPDSConnectionFactory
new WeakHashMap<PooledConnection, PooledConnectionAndInfo>();
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
*
* @param cpds the ConnectionPoolDataSource from which to obtain
* PooledConnection's
@@ -74,7 +74,7 @@ class CPDSConnectionFactory
* {@link Connection}s
* @param validationQuery a query to use to {@link #validateObject
validate}
* {@link Connection}s. Should return at least one row. May be
- * <tt>null</tt>
+ * <code>null</code>
* @param username
* @param password
*/
@@ -87,7 +87,7 @@ class CPDSConnectionFactory
}
/**
- * Create a new <tt>PoolableConnectionFactory</tt>.
+ * Create a new <code>PoolableConnectionFactory</code>.
*
* @param cpds the ConnectionPoolDataSource from which to obtain
* PooledConnection's
@@ -95,7 +95,7 @@ class CPDSConnectionFactory
* Connection}s
* @param validationQuery a query to use to {@link #validateObject
* validate} {@link Connection}s. Should return at least one row.
- * May be <tt>null</tt>
+ * May be <code>null</code>
* @param rollbackAfterValidation whether a rollback should be issued
* after {@link #validateObject validating} {@link Connection}s.
* @param username
diff --git
a/java/org/apache/tomcat/dbcp/dbcp/datasources/InstanceKeyDataSource.java
b/java/org/apache/tomcat/dbcp/dbcp/datasources/InstanceKeyDataSource.java
index 6f5fdfb..1d20be6 100644
--- a/java/org/apache/tomcat/dbcp/dbcp/datasources/InstanceKeyDataSource.java
+++ b/java/org/apache/tomcat/dbcp/dbcp/datasources/InstanceKeyDataSource.java
@@ -437,7 +437,7 @@ public abstract class InstanceKeyDataSource
}
/**
- * When <tt>true</tt>, objects will be
+ * When <code>true</code>, objects will be
* {*link PoolableObjectFactory#validateObject validated}
* before being returned by the {*link #borrowObject}
* method. If the object fails to validate,
@@ -451,7 +451,7 @@ public abstract class InstanceKeyDataSource
}
/**
- * When <tt>true</tt>, objects will be
+ * When <code>true</code>, objects will be
* {*link PoolableObjectFactory#validateObject validated}
* before being returned by the {*link #borrowObject}
* method. If the object fails to validate,
@@ -476,7 +476,7 @@ public abstract class InstanceKeyDataSource
}
/**
- * When <tt>true</tt>, objects will be
+ * When <code>true</code>, objects will be
* {*link PoolableObjectFactory#validateObject validated}
* before being returned to the pool within the
* {*link #returnObject}.
@@ -488,7 +488,7 @@ public abstract class InstanceKeyDataSource
}
/**
- * When <tt>true</tt>, objects will be
+ * When <code>true</code>, objects will be
* {*link PoolableObjectFactory#validateObject validated}
* before being returned to the pool within the
* {*link #returnObject}. For a <code>true</code> value to have any effect,
@@ -544,7 +544,7 @@ public abstract class InstanceKeyDataSource
* Sets the number of objects to examine during each run of the
* idle object evictor thread (if any).
* <p>
- * When a negative value is supplied, <tt>ceil({*link
#numIdle})/abs({*link #getNumTestsPerEvictionRun})</tt>
+ * When a negative value is supplied, <code>ceil({*link
#numIdle})/abs({*link #getNumTestsPerEvictionRun})</code>
* tests will be run. I.e., when the value is <i>-n</i>, roughly one
<i>n</i>th of the
* idle objects will be tested per run.
*
@@ -591,7 +591,7 @@ public abstract class InstanceKeyDataSource
}
/**
- * When <tt>true</tt>, objects will be
+ * When <code>true</code>, objects will be
* {*link PoolableObjectFactory#validateObject validated}
* by the idle object evictor (if any). If an object
* fails to validate, it will be dropped from the pool.
@@ -604,7 +604,7 @@ public abstract class InstanceKeyDataSource
}
/**
- * When <tt>true</tt>, objects will be
+ * When <code>true</code>, objects will be
* {*link PoolableObjectFactory#validateObject validated}
* by the idle object evictor (if any). If an object
* fails to validate, it will be dropped from the pool. For a
diff --git
a/java/org/apache/tomcat/dbcp/dbcp/datasources/KeyedCPDSConnectionFactory.java
b/java/org/apache/tomcat/dbcp/dbcp/datasources/KeyedCPDSConnectionFactory.java
index d0b3f2b..9025d46 100644
---
a/java/org/apache/tomcat/dbcp/dbcp/datasources/KeyedCPDSConnectionFactory.java
+++
b/java/org/apache/tomcat/dbcp/dbcp/datasources/KeyedCPDSConnectionFactory.java
@@ -66,11 +66,11 @@ class KeyedCPDSConnectionFactory implements
KeyedPoolableObjectFactory<UserPassK
new ConcurrentHashMap<PooledConnection, PooledConnectionAndInfo>();
/**
- * Create a new <tt>KeyedPoolableConnectionFactory</tt>.
+ * Create a new <code>KeyedPoolableConnectionFactory</code>.
* @param cpds the ConnectionPoolDataSource from which to obtain
PooledConnection's
* @param pool the {*link ObjectPool} in which to pool those {*link
Connection}s
* @param validationQuery a query to use to {*link #validateObject
validate} {*link Connection}s.
- * Should return at least one row. May be <tt>null</tt>
+ * Should return at least one row. May be <code>null</code>
*/
public KeyedCPDSConnectionFactory(ConnectionPoolDataSource cpds,
KeyedObjectPool<UserPassKey,
PooledConnectionAndInfo> pool,
@@ -79,13 +79,13 @@ class KeyedCPDSConnectionFactory implements
KeyedPoolableObjectFactory<UserPassK
}
/**
- * Create a new <tt>KeyedPoolableConnectionFactory</tt>.
+ * Create a new <code>KeyedPoolableConnectionFactory</code>.
* @param cpds the ConnectionPoolDataSource from which to obtain
* PooledConnections
* @param pool the {@link KeyedObjectPool} in which to pool those
* {@link Connection}s
* @param validationQuery a query to use to {@link #validateObject
validate}
- * {@link Connection}s. Should return at least one row. May be
<tt>null</tt>
+ * {@link Connection}s. Should return at least one row. May be
<code>null</code>
* @param rollbackAfterValidation whether a rollback should be issued after
* {@link #validateObject validating} {@link Connection}s.
*/
diff --git a/java/org/apache/tomcat/dbcp/jocl/ConstructorUtil.java
b/java/org/apache/tomcat/dbcp/jocl/ConstructorUtil.java
index 2bc9cba..07953fc 100644
--- a/java/org/apache/tomcat/dbcp/jocl/ConstructorUtil.java
+++ b/java/org/apache/tomcat/dbcp/jocl/ConstructorUtil.java
@@ -27,13 +27,13 @@ import java.lang.reflect.InvocationTargetException;
*/
public class ConstructorUtil {
/**
- * Returns a {@link Constructor} for the given method signature, or
<tt>null</tt>
- * if no such <tt>Constructor</tt> can be found.
+ * Returns a {@link Constructor} for the given method signature, or
<code>null</code>
+ * if no such <code>Constructor</code> can be found.
*
- * @param type the (non-<tt>null</tt>) type of {@link Object} the
returned {@link Constructor} should create
- * @param argTypes a non-<tt>null</tt> array of types describing the
parameters to the {@link Constructor}.
- * @return a {@link Constructor} for the given method signature, or
<tt>null</tt>
- * if no such <tt>Constructor</tt> can be found.
+ * @param type the (non-<code>null</code>) type of {@link Object} the
returned {@link Constructor} should create
+ * @param argTypes a non-<code>null</code> array of types describing the
parameters to the {@link Constructor}.
+ * @return a {@link Constructor} for the given method signature, or
<code>null</code>
+ * if no such <code>Constructor</code> can be found.
* @see #invokeConstructor
*/
public static <T> Constructor<T> getConstructor(Class<T> type, Class<?>[]
argTypes) {
@@ -76,14 +76,14 @@ public class ConstructorUtil {
}
/**
- * Creates a new instance of the specified <tt><i>type</i></tt>
+ * Creates a new instance of the specified <code><i>type</i></code>
* using a {@link Constructor} described by the given parameter types
* and values.
*
* @param type the type of {@link Object} to be created
- * @param argTypes a non-<tt>null</tt> array of types describing the
parameters to the {@link Constructor}.
- * @param argValues a non-<tt>null</tt> array containing the values of the
parameters to the {@link Constructor}.
- * @return a new instance of the specified <tt><i>type</i></tt>
+ * @param argTypes a non-<code>null</code> array of types describing the
parameters to the {@link Constructor}.
+ * @param argValues a non-<code>null</code> array containing the values of
the parameters to the {@link Constructor}.
+ * @return a new instance of the specified <code><i>type</i></code>
* using a {@link Constructor} described by the given parameter
types
* and values.
* @exception InstantiationException
diff --git
a/java/org/apache/tomcat/dbcp/pool/BaseKeyedPoolableObjectFactory.java
b/java/org/apache/tomcat/dbcp/pool/BaseKeyedPoolableObjectFactory.java
index cdbf915..77848b6 100644
--- a/java/org/apache/tomcat/dbcp/pool/BaseKeyedPoolableObjectFactory.java
+++ b/java/org/apache/tomcat/dbcp/pool/BaseKeyedPoolableObjectFactory.java
@@ -59,7 +59,7 @@ public abstract class BaseKeyedPoolableObjectFactory<K, V>
implements KeyedPoola
/**
* Ensures that the instance is safe to be returned by the pool.
* <p>
- * The default implementation always returns <tt>true</tt>.
+ * The default implementation always returns <code>true</code>.
* </p>
*
* @param key the key used when selecting the object
diff --git a/java/org/apache/tomcat/dbcp/pool/BasePoolableObjectFactory.java
b/java/org/apache/tomcat/dbcp/pool/BasePoolableObjectFactory.java
index c7179e9..3c6e296 100644
--- a/java/org/apache/tomcat/dbcp/pool/BasePoolableObjectFactory.java
+++ b/java/org/apache/tomcat/dbcp/pool/BasePoolableObjectFactory.java
@@ -49,10 +49,10 @@ public abstract class BasePoolableObjectFactory<T>
implements PoolableObjectFact
}
/**
- * This implementation always returns <tt>true</tt>.
+ * This implementation always returns <code>true</code>.
*
* @param obj ignored
- * @return <tt>true</tt>
+ * @return <code>true</code>
*/
@Override
public boolean validateObject(T obj) {
diff --git a/java/org/apache/tomcat/dbcp/pool/impl/CursorableLinkedList.java
b/java/org/apache/tomcat/dbcp/pool/impl/CursorableLinkedList.java
index f04f7a9..0246b1a 100644
--- a/java/org/apache/tomcat/dbcp/pool/impl/CursorableLinkedList.java
+++ b/java/org/apache/tomcat/dbcp/pool/impl/CursorableLinkedList.java
@@ -70,7 +70,7 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
* Appends the specified element to the end of this list.
*
* @param o element to be appended to this list.
- * @return <tt>true</tt>
+ * @return <code>true</code>
*/
@Override
public boolean add(E o) {
@@ -116,7 +116,7 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
* specified collection is this list, and it's nonempty.)
*
* @param c collection whose elements are to be added to this list.
- * @return <tt>true</tt> if this list changed as a result of the call.
+ * @return <code>true</code> if this list changed as a result of the call.
*
* @throws ClassCastException if the class of an element in the specified
* collection prevents it from being added to this list.
@@ -150,7 +150,7 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
* @param index index at which to insert first element from the specified
* collection.
* @param c elements to be inserted into this list.
- * @return <tt>true</tt> if this list changed as a result of the call.
+ * @return <code>true</code> if this list changed as a result of the call.
*
* @throws ClassCastException if the class of one of elements of the
* specified collection prevents it from being added to this
@@ -180,10 +180,10 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
/**
* Inserts the specified element at the beginning of this list.
- * (Equivalent to {@link #add(int,java.lang.Object) <tt>add(0,o)</tt>}).
+ * (Equivalent to {@link #add(int,java.lang.Object)
<code>add(0,o)</code>}).
*
* @param o element to be prepended to this list.
- * @return <tt>true</tt>
+ * @return <code>true</code>
*/
public boolean addFirst(E o) {
insertListable(null,_head.next(),o);
@@ -195,7 +195,7 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
* (Equivalent to {@link #add(java.lang.Object)}).
*
* @param o element to be appended to this list.
- * @return <tt>true</tt>
+ * @return <code>true</code>
*/
public boolean addLast(E o) {
insertListable(_head.prev(),null,o);
@@ -225,13 +225,13 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
}
/**
- * Returns <tt>true</tt> if this list contains the specified element.
- * More formally, returns <tt>true</tt> if and only if this list contains
- * at least one element <tt>e</tt> such that
- * <tt>(o==null ? e==null : o.equals(e))</tt>.
+ * Returns <code>true</code> if this list contains the specified element.
+ * More formally, returns <code>true</code> if and only if this list
contains
+ * at least one element <code>e</code> such that
+ * <code>(o==null ? e==null : o.equals(e))</code>.
*
* @param o element whose presence in this list is to be tested.
- * @return <tt>true</tt> if this list contains the specified element.
+ * @return <code>true</code> if this list contains the specified element.
*/
@Override
public boolean contains(Object o) {
@@ -245,11 +245,11 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
}
/**
- * Returns <tt>true</tt> if this list contains all of the elements of the
+ * Returns <code>true</code> if this list contains all of the elements of
the
* specified collection.
*
* @param c collection to be checked for containment in this list.
- * @return <tt>true</tt> if this list contains all of the elements of the
+ * @return <code>true</code> if this list contains all of the elements of
the
* specified collection.
*/
@Override
@@ -314,17 +314,17 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
/**
* Compares the specified object with this list for equality. Returns
- * <tt>true</tt> if and only if the specified object is also a list, both
+ * <code>true</code> if and only if the specified object is also a list,
both
* lists have the same size, and all corresponding pairs of elements in
- * the two lists are <i>equal</i>. (Two elements <tt>e1</tt> and
- * <tt>e2</tt> are <i>equal</i> if <tt>(e1==null ? e2==null :
- * e1.equals(e2))</tt>.) In other words, two lists are defined to be
+ * the two lists are <i>equal</i>. (Two elements <code>e1</code> and
+ * <code>e2</code> are <i>equal</i> if <code>(e1==null ? e2==null :
+ * e1.equals(e2))</code>.) In other words, two lists are defined to be
* equal if they contain the same elements in the same order. This
* definition ensures that the equals method works properly across
- * different implementations of the <tt>List</tt> interface.
+ * different implementations of the <code>List</code> interface.
*
* @param o the object to be compared for equality with this list.
- * @return <tt>true</tt> if the specified object is equal to this list.
+ * @return <code>true</code> if the specified object is equal to this list.
*/
@Override
public boolean equals(Object o) {
@@ -389,10 +389,10 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
* hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode());
* }
* </pre>
- * This ensures that <tt>list1.equals(list2)</tt> implies that
- * <tt>list1.hashCode()==list2.hashCode()</tt> for any two lists,
- * <tt>list1</tt> and <tt>list2</tt>, as required by the general
- * contract of <tt>Object.hashCode</tt>.
+ * This ensures that <code>list1.equals(list2)</code> implies that
+ * <code>list1.hashCode()==list2.hashCode()</code> for any two lists,
+ * <code>list1</code> and <code>list2</code>, as required by the general
+ * contract of <code>Object.hashCode</code>.
*
* @return the hash code value for this list.
* @see Object#hashCode()
@@ -411,8 +411,8 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
/**
* Returns the index in this list of the first occurrence of the specified
* element, or -1 if this list does not contain this element.
- * More formally, returns the lowest index <tt>i</tt> such that
- * <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt>,
+ * More formally, returns the lowest index <code>i</code> such that
+ * <code>(o==null ? get(i)==null : o.equals(get(i)))</code>,
* or -1 if there is no such index.
*
* @param o element to search for.
@@ -445,8 +445,8 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
}
/**
- * Returns <tt>true</tt> if this list contains no elements.
- * @return <tt>true</tt> if this list contains no elements.
+ * Returns <code>true</code> if this list contains no elements.
+ * @return <code>true</code> if this list contains no elements.
*/
@Override
public boolean isEmpty() {
@@ -465,8 +465,8 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
/**
* Returns the index in this list of the last occurrence of the specified
* element, or -1 if this list does not contain this element.
- * More formally, returns the highest index <tt>i</tt> such that
- * <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt>,
+ * More formally, returns the highest index <code>i</code> such that
+ * <code>(o==null ? get(i)==null : o.equals(get(i)))</code>,
* or -1 if there is no such index.
*
* @param o element to search for.
@@ -522,11 +522,11 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
* Removes the first occurrence in this list of the specified element.
* If this list does not contain the element, it is
* unchanged. More formally, removes the element with the lowest index i
- * such that <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt> (if
+ * such that <code>(o==null ? get(i)==null : o.equals(get(i)))</code> (if
* such an element exists).
*
* @param o element to be removed from this list, if present.
- * @return <tt>true</tt> if this list contained the specified element.
+ * @return <code>true</code> if this list contained the specified element.
*/
@Override
public boolean remove(Object o) {
@@ -568,7 +568,7 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
*
* @param c collection that defines which elements will be removed from
* this list.
- * @return <tt>true</tt> if this list changed as a result of the call.
+ * @return <code>true</code> if this list changed as a result of the call.
*/
@Override
public boolean removeAll(Collection<?> c) {
@@ -621,7 +621,7 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
*
* @param c collection that defines which elements this set will retain.
*
- * @return <tt>true</tt> if this list changed as a result of the call.
+ * @return <code>true</code> if this list changed as a result of the call.
*/
@Override
public boolean retainAll(Collection<?> c) {
@@ -968,11 +968,11 @@ class CursorableLinkedList<E> implements List<E>,
Serializable {
/**
* A sentry node.
* <p>
- * <tt>_head.next()</tt> points to the first element in the list,
- * <tt>_head.prev()</tt> to the last. Note that it is possible for
- * <tt>_head.next().prev()</tt> and <tt>_head.prev().next()</tt> to be
+ * <code>_head.next()</code> points to the first element in the list,
+ * <code>_head.prev()</code> to the last. Note that it is possible for
+ * <code>_head.next().prev()</code> and <code>_head.prev().next()</code>
to be
* non-null, as when I am a sublist for some larger list.
- * Use <tt>== _head.next()</tt> and <tt>== _head.prev()</tt> to determine
+ * Use <code>== _head.next()</code> and <code>== _head.prev()</code> to
determine
* if a given
* {@link org.apache.tomcat.dbcp.pool.impl.CursorableLinkedList.Listable}
* is the first or last element in the list.
diff --git a/java/org/apache/tomcat/util/codec/binary/Base64.java
b/java/org/apache/tomcat/util/codec/binary/Base64.java
index d03cde7..28d1c5d 100644
--- a/java/org/apache/tomcat/util/codec/binary/Base64.java
+++ b/java/org/apache/tomcat/util/codec/binary/Base64.java
@@ -27,13 +27,13 @@ import java.math.BigInteger;
* </p>
* <p>
* The class can be parameterized in the following manner with various
constructors:
+ * </p>
* <ul>
* <li>URL-safe mode: Default off.</li>
* <li>Line length: Default 76. Line length that aren't multiples of 4 will
still essentially end up being multiples of
* 4 in the encoded data.
* <li>Line separator: Default is CRLF ("\r\n")</li>
* </ul>
- * </p>
* <p>
* The URL-safe parameter is only applied to encode operations. Decoding only
handles standard mode.
* </p>
@@ -142,7 +142,7 @@ public class Base64 extends BaseNCodec {
private final byte[] decodeTable = DECODE_TABLE;
/**
- * Line separator for encoding. Not used when decoding. Only used if
lineLength > 0.
+ * Line separator for encoding. Not used when decoding. Only used if
lineLength > 0.
*/
private final byte[] lineSeparator;
@@ -206,7 +206,7 @@ public class Base64 extends BaseNCodec {
*
* @param lineLength
* Each line of encoded data will be at most of the given
length (rounded down to nearest multiple of
- * 4). If lineLength <= 0, then the output will not be divided
into lines (chunks). Ignored when
+ * 4). If lineLength <= 0, then the output will not be
divided into lines (chunks). Ignored when
* decoding.
* @since 1.4
*/
@@ -229,7 +229,7 @@ public class Base64 extends BaseNCodec {
*
* @param lineLength
* Each line of encoded data will be at most of the given
length (rounded down to nearest multiple of
- * 4). If lineLength <= 0, then the output will not be divided
into lines (chunks). Ignored when
+ * 4). If lineLength <= 0, then the output will not be
divided into lines (chunks). Ignored when
* decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of
bytes.
diff --git a/java/org/apache/tomcat/util/digester/CallParamRule.java
b/java/org/apache/tomcat/util/digester/CallParamRule.java
index 90c9cba..4d0e65f 100644
--- a/java/org/apache/tomcat/util/digester/CallParamRule.java
+++ b/java/org/apache/tomcat/util/digester/CallParamRule.java
@@ -14,19 +14,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-
package org.apache.tomcat.util.digester;
-
import org.xml.sax.Attributes;
-
/**
* <p>Rule implementation that saves a parameter for use by a surrounding
- * <code>CallMethodRule<code>.</p>
+ * <code>CallMethodRule</code>.</p>
*
- * <p>This parameter may be:
+ * <p>This parameter may be:</p>
* <ul>
* <li>from an attribute of the current element
* See {@link #CallParamRule(int paramIndex, String attributeName)}
@@ -37,9 +33,7 @@ import org.xml.sax.Attributes;
* <li>the current path being processed (separate <code>Rule</code>).
* See {@link PathCallParamRule}
* </ul>
- * </p>
*/
-
public class CallParamRule extends Rule {
// ----------------------------------------------------------- Constructors
@@ -51,9 +45,7 @@ public class CallParamRule extends Rule {
* @param paramIndex The zero-relative parameter number
*/
public CallParamRule(int paramIndex) {
-
this(paramIndex, null);
-
}
@@ -83,7 +75,6 @@ public class CallParamRule extends Rule {
this.paramIndex = paramIndex;
this.fromStack = fromStack;
-
}
/**
@@ -225,7 +216,6 @@ public class CallParamRule extends Rule {
*/
@Override
public String toString() {
-
StringBuilder sb = new StringBuilder("CallParamRule[");
sb.append("paramIndex=");
sb.append(paramIndex);
@@ -234,8 +224,7 @@ public class CallParamRule extends Rule {
sb.append(", from stack=");
sb.append(fromStack);
sb.append("]");
- return (sb.toString());
-
+ return sb.toString();
}
diff --git a/java/org/apache/tomcat/util/digester/ObjectParamRule.java
b/java/org/apache/tomcat/util/digester/ObjectParamRule.java
index 4dda755..a755868 100644
--- a/java/org/apache/tomcat/util/digester/ObjectParamRule.java
+++ b/java/org/apache/tomcat/util/digester/ObjectParamRule.java
@@ -14,28 +14,24 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-
package org.apache.tomcat.util.digester;
import org.xml.sax.Attributes;
/**
* <p>Rule implementation that saves a parameter for use by a surrounding
- * <code>CallMethodRule<code>.</p>
+ * <code>CallMethodRule</code>.</p>
*
- * <p>This parameter may be:
+ * <p>This parameter may be:</p>
* <ul>
* <li>an arbitrary Object defined programatically, assigned when the element
pattern associated with the Rule is matched
* See {@link #ObjectParamRule(int paramIndex, Object param)}
* <li>an arbitrary Object defined programatically, assigned if the element
pattern AND specified attribute name are matched
* See {@link #ObjectParamRule(int paramIndex, String attributeName, Object
param)}
* </ul>
- * </p>
*
* @since 1.4
*/
-
public class ObjectParamRule extends Rule {
// ----------------------------------------------------------- Constructors
/**
diff --git a/java/org/apache/tomcat/util/digester/WithDefaultsRulesWrapper.java
b/java/org/apache/tomcat/util/digester/WithDefaultsRulesWrapper.java
index ae75d3f..1baaacb 100644
--- a/java/org/apache/tomcat/util/digester/WithDefaultsRulesWrapper.java
+++ b/java/org/apache/tomcat/util/digester/WithDefaultsRulesWrapper.java
@@ -29,7 +29,7 @@ import java.util.List;
* existing <code>Rules</code> implementation. These default <code>Rule</code>
* instances will be returned for any match for which the wrapped
* implementation does not return any matches.</p>
- * <p> For example,
+ * <p> For example,</p>
* <pre>
* Rule alpha;
* ...
@@ -39,6 +39,7 @@ import java.util.List;
* digester.setRules(rules);
* ...
* </pre>
+ * <p>
* when a pattern does not match any other rule, then rule alpha will be
called.
* </p>
* <p><code>WithDefaultsRulesWrapper</code> follows the <em>Decorator</em>
pattern.</p>
diff --git a/java/org/apache/tomcat/util/http/ServerCookie.java
b/java/org/apache/tomcat/util/http/ServerCookie.java
index 530b411..9527737 100644
--- a/java/org/apache/tomcat/util/http/ServerCookie.java
+++ b/java/org/apache/tomcat/util/http/ServerCookie.java
@@ -30,7 +30,7 @@ import org.apache.tomcat.util.buf.MessageBytes;
/**
* Server-side cookie representation.
* Allows recycling and uses MessageBytes as low-level
- * representation ( and thus the byte-> char conversion can be delayed
+ * representation ( and thus the byte -> char conversion can be delayed
* until we know the charset ).
*
* Tomcat.core uses this recyclable object to represent cookies,
diff --git a/java/org/apache/tomcat/util/net/NioChannel.java
b/java/org/apache/tomcat/util/net/NioChannel.java
index 6765b6d..7cc3ff5 100644
--- a/java/org/apache/tomcat/util/net/NioChannel.java
+++ b/java/org/apache/tomcat/util/net/NioChannel.java
@@ -103,7 +103,7 @@ public class NioChannel implements ByteChannel{
/**
* Tells whether or not this channel is open.
*
- * @return <tt>true</tt> if, and only if, this channel is open
+ * @return <code>true</code> if, and only if, this channel is open
* TODO Implement this java.nio.channels.Channel method
*/
@Override
@@ -129,7 +129,7 @@ public class NioChannel implements ByteChannel{
* Reads a sequence of bytes from this channel into the given buffer.
*
* @param dst The buffer into which bytes are to be transferred
- * @return The number of bytes read, possibly zero, or <tt>-1</tt> if the
channel has reached end-of-stream
+ * @return The number of bytes read, possibly zero, or <code>-1</code> if
the channel has reached end-of-stream
* @throws IOException If some other I/O error occurs
* TODO Implement this java.nio.channels.ReadableByteChannel method
*/
diff --git a/java/org/apache/tomcat/util/net/SecureNioChannel.java
b/java/org/apache/tomcat/util/net/SecureNioChannel.java
index ac661cf..5872735 100644
--- a/java/org/apache/tomcat/util/net/SecureNioChannel.java
+++ b/java/org/apache/tomcat/util/net/SecureNioChannel.java
@@ -424,7 +424,7 @@ public class SecureNioChannel extends NioChannel {
* Reads a sequence of bytes from this channel into the given buffer.
*
* @param dst The buffer into which bytes are to be transferred
- * @return The number of bytes read, possibly zero, or <tt>-1</tt> if the
channel has reached end-of-stream
+ * @return The number of bytes read, possibly zero, or <code>-1</code> if
the channel has reached end-of-stream
* @throws IOException If some other I/O error occurs
* @throws IllegalArgumentException if the destination buffer is different
than bufHandler.getReadBuffer()
* TODO Implement this java.nio.channels.ReadableByteChannel method
diff --git a/java/org/apache/tomcat/util/net/URL.java
b/java/org/apache/tomcat/util/net/URL.java
index 5c9cbf3..fca3bde 100644
--- a/java/org/apache/tomcat/util/net/URL.java
+++ b/java/org/apache/tomcat/util/net/URL.java
@@ -14,15 +14,12 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.tomcat.util.net;
-
import java.io.Serializable;
import java.net.MalformedURLException;
import java.util.Locale;
-
/**
* <p><strong>URL</strong> is designed to provide public APIs for parsing
* and synthesizing Uniform Resource Locators as similar as possible to the
@@ -33,10 +30,10 @@ import java.util.Locale;
*
* <p><strong>WARNING</strong> - This class assumes that the string
* representation of a URL conforms to the <code>spec</code> argument
- * as described in RFC 2396 "Uniform Resource Identifiers: Generic Syntax":
+ * as described in RFC 2396 "Uniform Resource Identifiers: Generic Syntax":</p>
* <pre>
*
<scheme>//<authority><path>?<query>#<fragment>
- * </pre></p>
+ * </pre>
*
* <p><strong>FIXME</strong> - This class really ought to end up in a Commons
* package someplace.</p>
diff --git a/java/org/apache/tomcat/util/net/jsse/JSSESocketFactory.java
b/java/org/apache/tomcat/util/net/jsse/JSSESocketFactory.java
index 8980b71..a7192b1 100644
--- a/java/org/apache/tomcat/util/net/jsse/JSSESocketFactory.java
+++ b/java/org/apache/tomcat/util/net/jsse/JSSESocketFactory.java
@@ -72,7 +72,7 @@ import org.apache.tomcat.util.security.KeyStoreUtil;
/**
* SSL server socket factory. It <b>requires</b> a valid RSA key and
* JSSE.<br>
- * keytool -genkey -alias tomcat -keyalg RSA</br>
+ * keytool -genkey -alias tomcat -keyalg RSA<br>
* Use "changeit" as password (this is the default we use).
*
* @author Harish Prabandham
diff --git a/java/org/apache/tomcat/util/threads/ThreadPoolExecutor.java
b/java/org/apache/tomcat/util/threads/ThreadPoolExecutor.java
index a01d882..6d433d5 100644
--- a/java/org/apache/tomcat/util/threads/ThreadPoolExecutor.java
+++ b/java/org/apache/tomcat/util/threads/ThreadPoolExecutor.java
@@ -149,7 +149,7 @@ public class ThreadPoolExecutor extends
java.util.concurrent.ThreadPoolExecutor
/**
* Executes the given command at some time in the future. The command
* may execute in a new thread, in a pooled thread, or in the calling
- * thread, at the discretion of the <tt>Executor</tt> implementation.
+ * thread, at the discretion of the <code>Executor</code> implementation.
* If no threads are available, it will be added to the work queue.
* If the work queue is full, the system will wait for the specified
* time and it throw a RejectedExecutionException if the queue is still
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
