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
commit 8a648371516fda0d0034072c2833cd329201ea69
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Jan 21 23:04:56 2020 +0000
Clean-up. Javadoc warnings with newer JDKs. Align with 8.5.x.
---
java/org/apache/catalina/SessionEvent.java | 32 +++++++---------------
java/org/apache/catalina/SessionIdGenerator.java | 7 +++--
java/org/apache/catalina/comet/CometFilter.java | 6 ++--
.../apache/catalina/comet/CometFilterChain.java | 3 ++
java/org/apache/catalina/comet/CometProcessor.java | 5 ++--
5 files changed, 24 insertions(+), 29 deletions(-)
diff --git a/java/org/apache/catalina/SessionEvent.java
b/java/org/apache/catalina/SessionEvent.java
index 3a04c67..209121e 100644
--- a/java/org/apache/catalina/SessionEvent.java
+++ b/java/org/apache/catalina/SessionEvent.java
@@ -35,19 +35,19 @@ public final class SessionEvent extends EventObject {
/**
* The event data associated with this event.
*/
- private Object data = null;
+ private final Object data;
/**
* The Session on which this event occurred.
*/
- private Session session = null;
+ private final Session session;
/**
* The event type this instance represents.
*/
- private String type = null;
+ private final String type;
/**
@@ -68,44 +68,32 @@ public final class SessionEvent extends EventObject {
/**
- * Return the event data of this event.
+ * @return the event data of this event.
*/
public Object getData() {
-
- return (this.data);
-
+ return this.data;
}
/**
- * Return the Session on which this event occurred.
+ * @return the Session on which this event occurred.
*/
public Session getSession() {
-
- return (this.session);
-
+ return this.session;
}
/**
- * Return the event type of this event.
+ * @return the event type of this event.
*/
public String getType() {
-
- return (this.type);
-
+ return this.type;
}
- /**
- * Return a string representation of this event.
- */
@Override
public String toString() {
-
- return ("SessionEvent['" + getSession() + "','" +
- getType() + "']");
-
+ return "SessionEvent['" + getSession() + "','" + getType() + "']";
}
diff --git a/java/org/apache/catalina/SessionIdGenerator.java
b/java/org/apache/catalina/SessionIdGenerator.java
index b980d76..b11a4c3 100644
--- a/java/org/apache/catalina/SessionIdGenerator.java
+++ b/java/org/apache/catalina/SessionIdGenerator.java
@@ -19,7 +19,7 @@ package org.apache.catalina;
public interface SessionIdGenerator {
/**
- * Return the node identifier associated with this node which will be
+ * @return the node identifier associated with this node which will be
* included in the generated session ID.
*/
public String getJvmRoute();
@@ -33,7 +33,7 @@ public interface SessionIdGenerator {
public void setJvmRoute(String jvmRoute);
/**
- * Return the number of bytes for a session ID
+ * @return the number of bytes for a session ID
*/
public int getSessionIdLength();
@@ -46,6 +46,8 @@ public interface SessionIdGenerator {
/**
* Generate and return a new session identifier.
+ *
+ * @return the newly generated session id
*/
public String generateSessionId();
@@ -53,6 +55,7 @@ public interface SessionIdGenerator {
* Generate and return a new session identifier.
*
* @param route node identifier to include in generated id
+ * @return the newly generated session id
*/
public String generateSessionId(String route);
}
diff --git a/java/org/apache/catalina/comet/CometFilter.java
b/java/org/apache/catalina/comet/CometFilter.java
index f5bcfa6..b960ea3 100644
--- a/java/org/apache/catalina/comet/CometFilter.java
+++ b/java/org/apache/catalina/comet/CometFilter.java
@@ -71,9 +71,9 @@ public interface CometFilter extends Filter {
* 5. Directly set fields on the response after invocation of the next
entity in the filter chain.
*
* @param event the event that is being processed. Another event may be
passed along the chain.
- * @param chain
- * @throws IOException
- * @throws ServletException
+ * @param chain the chain of CometFilter instances for the current
request/response
+ * @throws IOException If an I/O error occurs
+ * @throws ServletException If an error occurs during event processing
*/
public void doFilterEvent(CometEvent event, CometFilterChain chain)
throws IOException, ServletException;
diff --git a/java/org/apache/catalina/comet/CometFilterChain.java
b/java/org/apache/catalina/comet/CometFilterChain.java
index 2b27d7b..25fb230 100644
--- a/java/org/apache/catalina/comet/CometFilterChain.java
+++ b/java/org/apache/catalina/comet/CometFilterChain.java
@@ -39,6 +39,9 @@ public interface CometFilterChain {
* in the chain, causes the resource at the end of the chain to be invoked.
*
* @param event the event to pass along the chain.
+ *
+ * @throws IOException If an I/O error occurs
+ * @throws ServletException If an error occurs during event processing
*/
public void doFilterEvent(CometEvent event) throws IOException,
ServletException;
diff --git a/java/org/apache/catalina/comet/CometProcessor.java
b/java/org/apache/catalina/comet/CometProcessor.java
index 4e22f8d..daa3062 100644
--- a/java/org/apache/catalina/comet/CometProcessor.java
+++ b/java/org/apache/catalina/comet/CometProcessor.java
@@ -36,8 +36,9 @@ public interface CometProcessor extends Servlet{
* Process the given Comet event.
*
* @param event The Comet event that will be processed
- * @throws IOException
- * @throws ServletException
+ *
+ * @throws IOException If an I/O error occurs
+ * @throws ServletException If an error occurs during event processing
*/
public void event(CometEvent event)
throws IOException, ServletException;
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
