[java-support] branch main updated: Javadoc tweaks.

[Scott Cantor]

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

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

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

The following commit(s) were added to refs/heads/main by this push:
       new  4f17526   Javadoc tweaks.
4f17526 is described below

commit 4f17526e7254d33209a9a52b62369356a1608d5c
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Mon Mar 8 18:04:01 2021 -0500

    Javadoc tweaks.
---
 .../shibboleth/utilities/java/support/codec/StringDigester.java    | 7 +++++++
 .../utilities/java/support/httpclient/HttpClientSupport.java       | 4 +++-
 .../utilities/java/support/resolver/ResolverSupport.java           | 5 ++---
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/src/main/java/net/shibboleth/utilities/java/support/codec/StringDigester.java b/src/main/java/net/shibboleth/utilities/java/support/codec/StringDigester.java
index b744dc4..c734af8 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/codec/StringDigester.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/codec/StringDigester.java
@@ -182,6 +182,13 @@ public class StringDigester implements Function<String,String> {
         return output;
     }
     
+    /**
+     * Apply the output encoding.
+     * 
+     * @param digestedBytes input to encoding
+     * 
+     * @return encoded string or null if the format is unknown
+     */
     @Nullable private String encodeOutput(@Nonnull final byte[] digestedBytes) {
         switch(outputFormat) {
             case BASE32:
diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java
index b857e5a..80df09e 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java
@@ -48,6 +48,7 @@ import org.apache.http.util.CharArrayBuffer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
 /**
@@ -58,7 +59,8 @@ public final class HttpClientSupport {
     /** Context key for instances of dynamic context handlers to be invoked before and after the HTTP request.
      * Must be an instance of
      * {@link java.util.List}<code><</code>{@link HttpClientContextHandler}<code>></code>. */
-    private static final String CONTEXT_KEY_DYNAMIC_CONTEXT_HANDLERS = "java-support.DynamicContextHandlers";
+    @Nonnull @NotEmpty
+    public static final String CONTEXT_KEY_DYNAMIC_CONTEXT_HANDLERS = "java-support.DynamicContextHandlers";
 
     /** Constructor to prevent instantiation. */
     private HttpClientSupport() { }
diff --git a/src/main/java/net/shibboleth/utilities/java/support/resolver/ResolverSupport.java b/src/main/java/net/shibboleth/utilities/java/support/resolver/ResolverSupport.java
index 004248a..36fb084 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/resolver/ResolverSupport.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/resolver/ResolverSupport.java
@@ -40,6 +40,8 @@ public final class ResolverSupport {
     /**
      * Obtain a set of {@link Predicate} based on a {@link CriteriaSet}.
      * 
+     * @param <T> the type of target which the returned predicates can evaluate
+     * @param <E> the type of criterion predicates to extract directly from the criteria set
      * @param criteriaSet the criteria set to evaluate
      * @param predicateCriterionType the optional type to evaluate and extract directly from the criteria set
      * @param registry the optional registry of mappings from {@link Criterion} to {@link Predicate}
@@ -47,9 +49,6 @@ public final class ResolverSupport {
      * @return a set of predicates, possibly empty
      * 
      * @throws ResolverException if there is a fatal error evaluating the criteria set
-     * 
-     * @param <T> the type of target which the returned predicates can evaluate
-     * @param <E> the type of criterion predicates to extract directly from the criteria set
      */
     @Nonnull
     public static <T, E extends Predicate<T>> Set<Predicate<T>> getPredicates(@Nullable final CriteriaSet criteriaSet, 

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