[tomcat] 04/04: Deprecate unused methods / methods that will be removed later

[markt]

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 60d3ab3636f0efe94b6e01a48dd6949585cd63d2
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Mon Mar 16 16:23:15 2020 +0000

    Deprecate unused methods / methods that will be removed later
---
 java/org/apache/tomcat/util/buf/UDecoder.java | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

diff --git a/java/org/apache/tomcat/util/buf/UDecoder.java 
b/java/org/apache/tomcat/util/buf/UDecoder.java
index 6d123ea..44696f2 100644
--- a/java/org/apache/tomcat/util/buf/UDecoder.java
+++ b/java/org/apache/tomcat/util/buf/UDecoder.java
@@ -68,7 +68,9 @@ public final class UDecoder {
     }
 
     /**
-     * URLDecode, will modify the source.
+     * URLDecode, will modify the source. Assumes source bytes are encoded 
using
+     * a superset of US-ASCII as per RFC 7230.
+     *
      * @param mb The URL encoded bytes
      * @throws IOException Invalid %xx URL encoding
      * @deprecated Unused. Will be removed in Tomcat 8.0.x onwards.
@@ -138,10 +140,12 @@ public final class UDecoder {
     }
 
     // -------------------- Additional methods --------------------
-    // XXX What do we do about charset ????
 
     /**
      * In-buffer processing - the buffer will be modified.
+     * <p>
+     * <b>WARNING:</b> This method assumes US-ASCII encoding.
+     *
      * @param mb The URL encoded chars
      * @throws IOException Invalid %xx URL encoding
      * @deprecated Unused. Will be removed in Tomcat 8.0.x onwards.
@@ -158,7 +162,10 @@ public final class UDecoder {
      * @param mb The URL encoded chars
      * @param query <code>true</code> if this is a query string
      * @throws IOException Invalid %xx URL encoding
+     *
+     * @deprecated Unused. Will be removed in Tomcat 10
      */
+    @Deprecated
     public void convert( CharChunk mb, boolean query )
         throws IOException
     {
@@ -226,10 +233,16 @@ public final class UDecoder {
 
     /**
      * URLDecode, will modify the source
+     * <p>
+     * <b>WARNING:</b> This method assumes US-ASCII encoding.
+     *
      * @param mb The URL encoded String, bytes or chars
      * @param query <code>true</code> if this is a query string
      * @throws IOException Invalid %xx URL encoding
+     *
+     * @deprecated Unused. Will be removed in Tomcat 10
      */
+    @Deprecated
     public void convert(MessageBytes mb, boolean query)
         throws IOException
     {
@@ -272,11 +285,19 @@ public final class UDecoder {
     }
 
     /**
-     * %xx decoding of a string. FIXME: this is inefficient.
+     * %xx decoding of a string.
+     * <p>
+     * <b>WARNING:</b> This method assumes US-ASCII encoding.
+     * <p>
+     * FIXME: this is inefficient.
+     *
      * @param str The URL encoded string
      * @param query <code>true</code> if this is a query string
      * @return the decoded string
+     *
+     * @deprecated Will be removed in Tomcat 10
      */
+    @Deprecated
     public final String convert(String str, boolean query)
     {
         if (str == null) {


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org