You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2023/01/13 10:52:07 UTC
[tomcat] 02/02: Fix various checkstyle warnings
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 8.5.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 47c9ee23dcbf02429a7038dfe8c49c618b589247
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Jan 13 10:51:51 2023 +0000
Fix various checkstyle warnings
---
java/javax/servlet/jsp/JspWriter.java | 2 +-
java/javax/servlet/jsp/tagext/TagData.java | 2 +-
.../catalina/core/ApplicationFilterConfig.java | 26 ++++++++++++--------
.../org/apache/catalina/mapper/MapperListener.java | 8 ++-----
java/org/apache/catalina/servlets/CGIServlet.java | 10 ++++----
.../apache/catalina/servlets/DefaultServlet.java | 2 +-
.../apache/jasper/servlet/JspServletWrapper.java | 2 +-
.../tomcat/dbcp/dbcp2/BasicDataSourceFactory.java | 8 +++----
.../org/apache/tomcat/dbcp/pool2/PooledObject.java | 2 +-
.../tomcat/dbcp/pool2/impl/AbandonedConfig.java | 2 +-
.../tomcat/util/bcel/classfile/ElementValue.java | 28 +++++++++++-----------
.../util/modeler/BaseNotificationBroadcaster.java | 2 +-
.../apache/tomcat/jdbc/pool/DataSourceFactory.java | 4 ++--
13 files changed, 49 insertions(+), 49 deletions(-)
diff --git a/java/javax/servlet/jsp/JspWriter.java b/java/javax/servlet/jsp/JspWriter.java
index 209059194d..fb2166869a 100644
--- a/java/javax/servlet/jsp/JspWriter.java
+++ b/java/javax/servlet/jsp/JspWriter.java
@@ -23,7 +23,7 @@ import java.io.IOException;
* The actions and template data in a JSP page is written using the JspWriter
* object that is referenced by the implicit variable out which is initialized
* automatically using methods in the PageContext object.
- *<p>
+ * <p>
* This abstract class emulates some of the functionality found in the
* java.io.BufferedWriter and java.io.PrintWriter classes, however it differs in
* that it throws java.io.IOException from the print methods while PrintWriter
diff --git a/java/javax/servlet/jsp/tagext/TagData.java b/java/javax/servlet/jsp/tagext/TagData.java
index 9740164b35..d603811228 100644
--- a/java/javax/servlet/jsp/tagext/TagData.java
+++ b/java/javax/servlet/jsp/tagext/TagData.java
@@ -140,7 +140,7 @@ public class TagData implements Cloneable {
/**
* Enumerates the attributes.
*
- *@return An enumeration of the attributes in a TagData
+ * @return An enumeration of the attributes in a TagData
*/
public java.util.Enumeration<String> getAttributes() {
return attributes.keys();
diff --git a/java/org/apache/catalina/core/ApplicationFilterConfig.java b/java/org/apache/catalina/core/ApplicationFilterConfig.java
index b29ca30847..33e76a400c 100644
--- a/java/org/apache/catalina/core/ApplicationFilterConfig.java
+++ b/java/org/apache/catalina/core/ApplicationFilterConfig.java
@@ -85,11 +85,14 @@ public final class ApplicationFilterConfig implements FilterConfig, Serializable
* @exception InstantiationException if an exception occurs while
* instantiating the filter object
* @exception ServletException if thrown by the filter's init() method
- * @throws NamingException
- * @throws InvocationTargetException
- * @throws SecurityException
- * @throws NoSuchMethodException
- * @throws IllegalArgumentException
+ * @throws NamingException If a JNDI lookup fails
+ * @throws InvocationTargetException If an error occurs initialising the
+ * filter
+ * @throws SecurityException If a security manager prevents the creation
+ * @throws NoSuchMethodException If the constructor for the filter cannot
+ * be found
+ * @throws IllegalArgumentException If the provided configuration is not
+ * valid
*/
ApplicationFilterConfig(Context context, FilterDef filterDef)
throws ClassCastException, ClassNotFoundException, IllegalAccessException,
@@ -240,11 +243,14 @@ public final class ApplicationFilterConfig implements FilterConfig, Serializable
* @exception InstantiationException if an exception occurs while
* instantiating the filter object
* @exception ServletException if thrown by the filter's init() method
- * @throws NamingException
- * @throws InvocationTargetException
- * @throws SecurityException
- * @throws NoSuchMethodException
- * @throws IllegalArgumentException
+ * @throws NamingException If a JNDI lookup fails
+ * @throws InvocationTargetException If an error occurs initialising the
+ * filter
+ * @throws SecurityException If a security manager prevents the creation
+ * @throws NoSuchMethodException If the constructor for the filter cannot
+ * be found
+ * @throws IllegalArgumentException If the provided configuration is not
+ * valid
*/
Filter getFilter() throws ClassCastException, ClassNotFoundException, IllegalAccessException,
InstantiationException, ServletException, InvocationTargetException, NamingException,
diff --git a/java/org/apache/catalina/mapper/MapperListener.java b/java/org/apache/catalina/mapper/MapperListener.java
index 80139206d4..0dadb1c82c 100644
--- a/java/org/apache/catalina/mapper/MapperListener.java
+++ b/java/org/apache/catalina/mapper/MapperListener.java
@@ -141,7 +141,7 @@ public class MapperListener extends LifecycleMBeanBase
@Override
protected String getObjectNameKeyProperties() {
// Same as connector but Mapper rather than Connector
- return ("type=Mapper");
+ return "type=Mapper";
}
// --------------------------------------------- Container Listener methods
@@ -454,13 +454,9 @@ public class MapperListener extends LifecycleMBeanBase
}
}
- /**
+ /*
* Populate <code>wrappers</code> list with information for registration of
* mappings for this wrapper in this context.
- *
- * @param context
- * @param wrapper
- * @param wrappers
*/
private void prepareWrapperMappingInfo(Context context, Wrapper wrapper,
List<WrapperMappingInfo> wrappers) {
diff --git a/java/org/apache/catalina/servlets/CGIServlet.java b/java/org/apache/catalina/servlets/CGIServlet.java
index 1b6e5cb9da..a80c5d1911 100644
--- a/java/org/apache/catalina/servlets/CGIServlet.java
+++ b/java/org/apache/catalina/servlets/CGIServlet.java
@@ -856,18 +856,18 @@ public final class CGIServlet extends HttpServlet {
* CGI search algorithm: search the real path below
* <my-webapp-root> and find the first non-directory in
* the getPathTranslated("/"), reading/searching from left-to-right.
- *</p>
- *<p>
+ * </p>
+ * <p>
* The CGI search path will start at
* webAppRootDir + File.separator + cgiPathPrefix
* (or webAppRootDir alone if cgiPathPrefix is
* null).
- *</p>
- *<p>
+ * </p>
+ * <p>
* cgiPathPrefix is defined by setting
* this servlet's cgiPathPrefix init parameter
*
- *</p>
+ * </p>
*
* @param pathInfo String from HttpServletRequest.getPathInfo()
* @param webAppRootDir String from context.getRealPath("/")
diff --git a/java/org/apache/catalina/servlets/DefaultServlet.java b/java/org/apache/catalina/servlets/DefaultServlet.java
index 498bac896e..10cc0625c3 100644
--- a/java/org/apache/catalina/servlets/DefaultServlet.java
+++ b/java/org/apache/catalina/servlets/DefaultServlet.java
@@ -109,7 +109,7 @@ import org.xml.sax.ext.EntityResolver2;
* from the web application resource root using the full path from the root
* of the web application context.
* <br>e.g. given a web application structure:
- *</p>
+ * </p>
* <pre>
* /context
* /images
diff --git a/java/org/apache/jasper/servlet/JspServletWrapper.java b/java/org/apache/jasper/servlet/JspServletWrapper.java
index 34e8e4d7a9..9e95e7f685 100644
--- a/java/org/apache/jasper/servlet/JspServletWrapper.java
+++ b/java/org/apache/jasper/servlet/JspServletWrapper.java
@@ -550,7 +550,7 @@ public class JspServletWrapper {
* information, and a snippet of the JSP to help debugging.
* Please see https://bz.apache.org/bugzilla/show_bug.cgi?id=37062 and
* http://www.tfenne.com/jasper/ for more details.
- *</p>
+ * </p>
*
* @param ex the exception that was the cause of the problem.
* @return a JasperException with more detailed information
diff --git a/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSourceFactory.java b/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSourceFactory.java
index 7f63be4af3..dd0277d4f8 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSourceFactory.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSourceFactory.java
@@ -570,13 +570,11 @@ public class BasicDataSourceFactory implements ObjectFactory {
}
/**
- * <p>
* Parse properties from the string. Format of the string must be [propertyName=property;]*
- * <p>
*
- * @param propText
- * @return Properties
- * @throws Exception
+ * @param propText The source text
+ * @return Properties A new Properties instance
+ * @throws Exception When a paring exception occurs
*/
private static Properties getProperties(final String propText) throws Exception {
final Properties p = new Properties();
diff --git a/java/org/apache/tomcat/dbcp/pool2/PooledObject.java b/java/org/apache/tomcat/dbcp/pool2/PooledObject.java
index b25bdcefd0..bbbdb6a8f4 100644
--- a/java/org/apache/tomcat/dbcp/pool2/PooledObject.java
+++ b/java/org/apache/tomcat/dbcp/pool2/PooledObject.java
@@ -102,7 +102,7 @@ public interface PooledObject<T> extends Comparable<PooledObject<T>> {
/**
* Orders instances based on idle time - i.e. the length of time since the
* instance was returned to the pool. Used by the GKOP idle object evictor.
- *<p>
+ * <p>
* Note: This class has a natural ordering that is inconsistent with
* equals if distinct objects have the same identity hash code.
* </p>
diff --git a/java/org/apache/tomcat/dbcp/pool2/impl/AbandonedConfig.java b/java/org/apache/tomcat/dbcp/pool2/impl/AbandonedConfig.java
index 395d2bbdc9..a5f2c80e50 100644
--- a/java/org/apache/tomcat/dbcp/pool2/impl/AbandonedConfig.java
+++ b/java/org/apache/tomcat/dbcp/pool2/impl/AbandonedConfig.java
@@ -76,7 +76,7 @@ public class AbandonedConfig {
* <p>If set to true, abandoned objects are removed by the pool
* maintenance thread when it runs. This setting has no effect
* unless maintenance is enabled by setting
- *{@link GenericObjectPool#getTimeBetweenEvictionRunsMillis() timeBetweenEvictionRunsMillis}
+ * {@link GenericObjectPool#getTimeBetweenEvictionRunsMillis() timeBetweenEvictionRunsMillis}
* to a positive number.</p>
*
* @return true if abandoned objects are to be removed by the evictor
diff --git a/java/org/apache/tomcat/util/bcel/classfile/ElementValue.java b/java/org/apache/tomcat/util/bcel/classfile/ElementValue.java
index c0a421a840..cdef7b262a 100644
--- a/java/org/apache/tomcat/util/bcel/classfile/ElementValue.java
+++ b/java/org/apache/tomcat/util/bcel/classfile/ElementValue.java
@@ -26,24 +26,24 @@ import org.apache.tomcat.util.bcel.Const;
*
* <pre>
* element_value {
- * u1 tag;
- * union {
- * u2 const_value_index;
+ * u1 tag;
+ * union {
+ * u2 const_value_index;
*
- * { u2 type_name_index;
- * u2 const_name_index;
- * } enum_const_value;
+ * { u2 type_name_index;
+ * u2 const_name_index;
+ * } enum_const_value;
*
- * u2 class_info_index;
+ * u2 class_info_index;
*
- * annotation annotation_value;
+ * annotation annotation_value;
*
- * { u2 num_values;
- * element_value values[num_values];
- * } array_value;
- * } value;
- *}
- *</pre>
+ * { u2 num_values;
+ * element_value values[num_values];
+ * } array_value;
+ * } value;
+ * }
+ * </pre>
*/
public abstract class ElementValue {
diff --git a/java/org/apache/tomcat/util/modeler/BaseNotificationBroadcaster.java b/java/org/apache/tomcat/util/modeler/BaseNotificationBroadcaster.java
index fc6549b4a0..7add1aaeca 100644
--- a/java/org/apache/tomcat/util/modeler/BaseNotificationBroadcaster.java
+++ b/java/org/apache/tomcat/util/modeler/BaseNotificationBroadcaster.java
@@ -32,7 +32,7 @@ import javax.management.NotificationListener;
* <p>Implementation of <code>NotificationBroadcaster</code> for attribute
* change notifications. This class is used by <code>BaseModelMBean</code> to
* handle notifications of attribute change events to interested listeners.
- *</p>
+ * </p>
*
* @author Craig R. McClanahan
* @author Costin Manolache
diff --git a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java
index 8e16bfd01f..b0fe0738e5 100644
--- a/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java
+++ b/modules/jdbc-pool/src/main/java/org/apache/tomcat/jdbc/pool/DataSourceFactory.java
@@ -43,14 +43,14 @@ import org.apache.juli.logging.LogFactory;
* <br>
* Properties available for configuration:<br>
* <a href="https://commons.apache.org/dbcp/configuration.html">Commons DBCP properties</a><br>
- *<ol>
+ * <ol>
* <li>initSQL - A query that gets executed once, right after the connection is established.</li>
* <li>testOnConnect - run validationQuery after connection has been established.</li>
* <li>validationInterval - avoid excess validation, only run validation at most at this frequency - time in milliseconds.</li>
* <li>jdbcInterceptors - a semicolon separated list of classnames extending {@link JdbcInterceptor} class.</li>
* <li>jmxEnabled - true of false, whether to register the pool with JMX.</li>
* <li>fairQueue - true of false, whether the pool should sacrifice a little bit of performance for true fairness.</li>
- *</ol>
+ * </ol>
* @author Craig R. McClanahan
* @author Dirk Verbeeck
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org