(tomcat) branch main updated: Remove override javadoc

2024-03-29 Thread remm
This is an automated email from the ASF dual-hosted git repository.

remm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 2c3e8e19d7 Remove override javadoc
2c3e8e19d7 is described below

commit 2c3e8e19d7c67ca6e3e9c319d33c2d6e3f53cbab
Author: remm 
AuthorDate: Fri Mar 29 11:52:04 2024 +0100

Remove override javadoc

Remove very outdated boilerplate override javadoc from the
Servlet/Catalina API.
---
 .../apache/catalina/ha/session/DeltaSession.java   | 148 --
 .../apache/catalina/session/StandardSession.java   | 214 -
 2 files changed, 362 deletions(-)

diff --git a/java/org/apache/catalina/ha/session/DeltaSession.java 
b/java/org/apache/catalina/ha/session/DeltaSession.java
index a20d4db0b8..6e18731831 100644
--- a/java/org/apache/catalina/ha/session/DeltaSession.java
+++ b/java/org/apache/catalina/ha/session/DeltaSession.java
@@ -116,34 +116,16 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 
 // - ReplicatedMapEntry
 
-/**
- * Has the object changed since last replication and is not in a locked 
state
- *
- * @return boolean
- */
 @Override
 public boolean isDirty() {
 return deltaRequest.getSize() > 0;
 }
 
-/**
- * If this returns true, the map will extract the diff using getDiff() 
Otherwise it will serialize the entire
- * object.
- *
- * @return boolean
- */
 @Override
 public boolean isDiffable() {
 return true;
 }
 
-/**
- * Returns a diff and sets the dirty map to false
- *
- * @return a serialized view of the difference
- *
- * @throws IOException IO error serializing
- */
 @Override
 public byte[] getDiff() throws IOException {
 SynchronizedStack deltaRequestPool = null;
@@ -183,15 +165,6 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 return null;
 }
 
-/**
- * Applies a diff to an existing object.
- *
- * @param diff   Serialized diff data
- * @param offset Array offset
- * @param length Array length
- *
- * @throws IOException IO error deserializing
- */
 @Override
 public void applyDiff(byte[] diff, int offset, int length) throws 
IOException, ClassNotFoundException {
 Thread currentThread = Thread.currentThread();
@@ -267,11 +240,6 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 }
 }
 
-/**
- * If this returns true, to replicate that an object has been accessed
- *
- * @return boolean
- */
 @Override
 public boolean isAccessReplicate() {
 long replDelta = System.currentTimeMillis() - getLastTimeReplicated();
@@ -281,9 +249,6 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 return false;
 }
 
-/**
- * Access to an existing object.
- */
 @Override
 public void accessEntry() {
 this.access();
@@ -293,19 +258,11 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 
 // - Session Properties
 
-/**
- * returns true if this session is the primary session, if that is the 
case, the manager can expire it upon timeout.
- */
 @Override
 public boolean isPrimarySession() {
 return isPrimarySession;
 }
 
-/**
- * Sets whether this is the primary session or not.
- *
- * @param primarySession Flag value
- */
 @Override
 public void setPrimarySession(boolean primarySession) {
 this.isPrimarySession = primarySession;
@@ -324,11 +281,6 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 }
 
 
-/**
- * Set the session identifier for this session.
- *
- * @param id The new session identifier
- */
 @Override
 public void setId(String id) {
 setId(id, true);
@@ -353,11 +305,6 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 }
 }
 
-/**
- * Set the isNew flag for this session.
- *
- * @param isNew The new value for the isNew flag
- */
 @Override
 public void setNew(boolean isNew) {
 setNew(isNew, true);
@@ -375,13 +322,6 @@ public class DeltaSession extends StandardSession 
implements Externalizable, Clu
 }
 }
 
-/**
- * Set the authenticated Principal that is associated with this Session. 
This provides an Authenticator
- * with a means to cache a previously authenticated Principal, and avoid 
potentially expensive
- * Realm.authenticate() calls on every request.
- *
- * @param principal The new Principal, or null if 

(tomcat) branch main updated: Remove override javadoc

2024-03-29 Thread remm
This is an automated email from the ASF dual-hosted git repository.

remm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new 156d01a719 Remove override javadoc
156d01a719 is described below

commit 156d01a719c13531917a9d21bf6cdd8ef8062a9a
Author: remm 
AuthorDate: Fri Mar 29 11:26:25 2024 +0100

Remove override javadoc

Remove very outdated boilerplate override javadoc from the Servlet API.
---
 .../org/apache/catalina/core/ApplicationContext.java | 10 --
 .../apache/catalina/core/ApplicationDispatcher.java  | 20 
 .../apache/catalina/core/ApplicationFilterChain.java | 10 --
 .../catalina/core/ApplicationFilterConfig.java   | 18 --
 java/org/apache/catalina/core/StandardWrapper.java   | 15 ---
 5 files changed, 73 deletions(-)

diff --git a/java/org/apache/catalina/core/ApplicationContext.java 
b/java/org/apache/catalina/core/ApplicationContext.java
index b01ee91382..806ce3710d 100644
--- a/java/org/apache/catalina/core/ApplicationContext.java
+++ b/java/org/apache/catalina/core/ApplicationContext.java
@@ -303,11 +303,6 @@ public class ApplicationContext implements ServletContext {
 }
 
 
-/**
- * Return the MIME type of the specified file, or null if the 
MIME type cannot be determined.
- *
- * @param file Filename for which to identify a MIME type
- */
 @Override
 public String getMimeType(String file) {
 
@@ -327,11 +322,6 @@ public class ApplicationContext implements ServletContext {
 }
 
 
-/**
- * Return a RequestDispatcher object that acts as a wrapper 
for the named servlet.
- *
- * @param name Name of the servlet for which a dispatcher is requested
- */
 @Override
 public RequestDispatcher getNamedDispatcher(String name) {
 
diff --git a/java/org/apache/catalina/core/ApplicationDispatcher.java 
b/java/org/apache/catalina/core/ApplicationDispatcher.java
index 08e43c84a2..245a1a85ea 100644
--- a/java/org/apache/catalina/core/ApplicationDispatcher.java
+++ b/java/org/apache/catalina/core/ApplicationDispatcher.java
@@ -198,16 +198,6 @@ final class ApplicationDispatcher implements 
AsyncDispatcher, RequestDispatcher
 // - Public Methods
 
 
-/**
- * Forward this request and response to another resource for processing. 
Any runtime exception, IOException, or
- * ServletException thrown by the called servlet will be propagated to the 
caller.
- *
- * @param request  The servlet request to be forwarded
- * @param response The servlet response to be forwarded
- *
- * @exception IOException  if an input/output error occurs
- * @exception ServletException if a servlet exception occurs
- */
 @Override
 public void forward(ServletRequest request, ServletResponse response) 
throws ServletException, IOException {
 // Reset any output that has been buffered, but keep headers/cookies
@@ -390,16 +380,6 @@ final class ApplicationDispatcher implements 
AsyncDispatcher, RequestDispatcher
 }
 
 
-/**
- * Include the response from another resource in the current response. Any 
runtime exception, IOException, or
- * ServletException thrown by the called servlet will be propagated to the 
caller.
- *
- * @param request  The servlet request that is including this one
- * @param response The servlet response to be appended to
- *
- * @exception IOException  if an input/output error occurs
- * @exception ServletException if a servlet exception occurs
- */
 @Override
 public void include(ServletRequest request, ServletResponse response) 
throws ServletException, IOException {
 // Set up to handle the specified request and response
diff --git a/java/org/apache/catalina/core/ApplicationFilterChain.java 
b/java/org/apache/catalina/core/ApplicationFilterChain.java
index fd7a892d1a..9d4a3a3437 100644
--- a/java/org/apache/catalina/core/ApplicationFilterChain.java
+++ b/java/org/apache/catalina/core/ApplicationFilterChain.java
@@ -95,16 +95,6 @@ public final class ApplicationFilterChain implements 
FilterChain {
 
 //  FilterChain Methods
 
-/**
- * Invoke the next filter in this chain, passing the specified request and 
response. If there are no more filters in
- * this chain, invoke the service() method of the servlet 
itself.
- *
- * @param request  The servlet request we are processing
- * @param response The servlet response we are creating
- *
- * @exception IOException  if an input/output error occurs
- * @exception ServletException if a servlet exception occurs
- */
 @Override
 public void doFilter(ServletRequest request, ServletResponse response) 
throws IOException, 

(tomcat) branch main updated: Remove override javadoc

2024-03-29 Thread remm
This is an automated email from the ASF dual-hosted git repository.

remm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
 new c327f7be9f Remove override javadoc
c327f7be9f is described below

commit c327f7be9fb77892c4da59d318288ce5bc760a2c
Author: remm 
AuthorDate: Fri Mar 29 11:05:39 2024 +0100

Remove override javadoc

Remove very outdated boilerplate override javadoc from the Servlet API.
---
 java/org/apache/catalina/connector/Request.java  | 197 ---
 java/org/apache/catalina/connector/Response.java | 152 -
 2 files changed, 349 deletions(-)

diff --git a/java/org/apache/catalina/connector/Request.java 
b/java/org/apache/catalina/connector/Request.java
index d78887ce3a..f57888357f 100644
--- a/java/org/apache/catalina/connector/Request.java
+++ b/java/org/apache/catalina/connector/Request.java
@@ -831,11 +831,6 @@ public class Request implements HttpServletRequest {
 
 // - ServletRequest Methods
 
-/**
- * @return the specified request attribute if it exists; otherwise, return 
null.
- *
- * @param name Name of the request attribute to return
- */
 @SuppressWarnings("deprecation")
 @Override
 public Object getAttribute(String name) {
@@ -941,9 +936,6 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the character encoding for this Request.
- */
 @Override
 public String getCharacterEncoding() {
 String characterEncoding = coyoteRequest.getCharsetHolder().getName();
@@ -977,18 +969,12 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the content length for this Request.
- */
 @Override
 public int getContentLength() {
 return coyoteRequest.getContentLength();
 }
 
 
-/**
- * @return the content type for this Request.
- */
 @Override
 public String getContentType() {
 return coyoteRequest.getContentType();
@@ -1005,13 +991,6 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the servlet input stream for this Request. The default 
implementation returns a servlet input stream
- * created by createInputStream().
- *
- * @exception IllegalStateException if getReader() has 
already been called for this request
- * @exception IOException   if an input/output error occurs
- */
 @Override
 public ServletInputStream getInputStream() throws IOException {
 
@@ -1028,11 +1007,6 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the preferred Locale that the client will accept content in, 
based on the value for the first
- * Accept-Language header that was encountered. 
If the request did not specify a preferred
- * language, the server's default Locale is returned.
- */
 @Override
 public Locale getLocale() {
 
@@ -1048,11 +1022,6 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the set of preferred Locales that the client will accept 
content in, based on the values for any
- * Accept-Language headers that were encountered. 
If the request did not specify a
- * preferred language, the server's default Locale is returned.
- */
 @Override
 public Enumeration getLocales() {
 
@@ -,24 +1080,12 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the protocol and version used to make this Request.
- */
 @Override
 public String getProtocol() {
 return coyoteRequest.protocol().toStringType();
 }
 
 
-/**
- * Read the Reader wrapping the input stream for this Request. The default 
implementation wraps a
- * BufferedReader around the servlet input stream returned by 
createInputStream().
- *
- * @return a buffered reader for the request
- *
- * @exception IllegalStateException if getInputStream() has 
already been called for this request
- * @exception IOException   if an input/output error occurs
- */
 @Override
 public BufferedReader getReader() throws IOException {
 
@@ -1164,9 +1121,6 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the remote IP address making this Request.
- */
 @Override
 public String getRemoteAddr() {
 if (remoteAddr == null) {
@@ -1189,9 +1143,6 @@ public class Request implements HttpServletRequest {
 }
 
 
-/**
- * @return the remote host name making this Request.
- */
 @Override
 public String getRemoteHost() {
 if (remoteHost == null) {
@@ -1205,9 +1156,6 @@ public class Request implements HttpServletRequest {