[java-support] branch master updated: Add some warnings to javadoc.

[Scott Cantor]

This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to branch master
in repository java-support.

View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=c9b02dcb2d76137f1b8799862a606677299a159e

The following commit(s) were added to refs/heads/master by this push:
       new  c9b02dc   Add some warnings to javadoc.
c9b02dc is described below

commit c9b02dcb2d76137f1b8799862a606677299a159e
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Fri Sep 2 15:20:21 2016 -0400

    Add some warnings to javadoc.
---
 .../net/shibboleth/utilities/java/support/net/URISupport.java    | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java b/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java
index 2e7656f..b723013 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java
@@ -365,6 +365,8 @@ public final class URISupport {
     /**
      * Perform URL decoding on the given string.
      * 
+     * <p>Consider using Guava's UrlEscapers class for any future uses for this functionality.</p>
+     * 
      * @param value the string to decode
      * @return the decoded string
      */
@@ -382,7 +384,12 @@ public final class URISupport {
     }
 
     /**
-     * Perform URL encoding on the given string.
+     * Perform URL encoding on the given string appropriate for form or query string parameters.
+     * 
+     * <p>This method is <strong>not</strong> appropriate for the encoding of data for other
+     * parts of a URL such as a path or fragment.</p>
+     * 
+     * <p>Consider using Guava's UrlEscapers class for any future uses for this functionality.</p>
      * 
      * @param value the string to encode
      * @return the encoded string

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.