[java-shib-shared] 01/02: Javadoc cleanup.

[Codeberg]

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

codeberg pushed a commit to branch main
in repository java-shib-shared.

View the commit online:
https://codeberg.org/Shibboleth/java-shib-shared/commit/40992560fa10fa69b26750291cca28e2654d52d1

commit 40992560fa10fa69b26750291cca28e2654d52d1
Author: Scott Cantor <scott at restingparrotsoftware.com>
AuthorDate: Mon Aug 3 08:33:12 2026 -0400

    Javadoc cleanup.
---
 .../shared/httpclient/RequestTimeoutExceededException.java       | 1 +
 .../src/main/java/net/shibboleth/shared/net/CookieManager.java   | 3 ++-
 .../shared/spring/factory/EvaluableScriptFactoryBean.java        | 9 +++++----
 .../net/shibboleth/shared/testing/MockExceptionCriterion.java    | 1 +
 4 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/shib-networking/src/main/java/net/shibboleth/shared/httpclient/RequestTimeoutExceededException.java b/shib-networking/src/main/java/net/shibboleth/shared/httpclient/RequestTimeoutExceededException.java
index dfc317d5..b6d3c825 100644
--- a/shib-networking/src/main/java/net/shibboleth/shared/httpclient/RequestTimeoutExceededException.java
+++ b/shib-networking/src/main/java/net/shibboleth/shared/httpclient/RequestTimeoutExceededException.java
@@ -25,6 +25,7 @@ import javax.annotation.Nullable;
  */
 public class RequestTimeoutExceededException extends IOException {
 
+    /** Serial version UID. */
     private static final long serialVersionUID = -4315409154151655702L;
 
     /**
diff --git a/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java b/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java
index 68b75a44..a1c752b2 100644
--- a/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java
+++ b/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java
@@ -339,7 +339,7 @@ public class CookieManager extends AbstractInitializableComponent {
      * 
      * <p>Defaults to true.</p>
      * 
-     * @param flag
+     * @param flag flag to set
      */
     public void setGuardSetAttribute(final boolean flag) {
         checkSetterPreconditions();
@@ -673,6 +673,7 @@ public class CookieManager extends AbstractInitializableComponent {
         int purgedCookies = 0;
         
         for (final String nameToPurge : sortedNames.descendingSet()) {
+            assert nameToPurge != null;
             if (maxCookies > 0) {
                 // Keep it but count against limit.
                 --maxCookies;
diff --git a/shib-spring/src/main/java/net/shibboleth/shared/spring/factory/EvaluableScriptFactoryBean.java b/shib-spring/src/main/java/net/shibboleth/shared/spring/factory/EvaluableScriptFactoryBean.java
index be9039e7..92f53a3f 100644
--- a/shib-spring/src/main/java/net/shibboleth/shared/spring/factory/EvaluableScriptFactoryBean.java
+++ b/shib-spring/src/main/java/net/shibboleth/shared/spring/factory/EvaluableScriptFactoryBean.java
@@ -30,7 +30,7 @@ import net.shibboleth.shared.scripting.EvaluableScript;
 /**
  * A factory bean to summon up an {@link EvaluableScript} from either inline data or from a resource.
  *
- * TODO: Remove the {@link #destroyInstance()} from this class in V6.
+ * TODO: Remove the {@link #destroyInstance(EvaluableScript)} from this class in V6.
  */
 
 public class EvaluableScriptFactoryBean extends AbstractComponentAwareFactoryBean<EvaluableScript> {
@@ -172,10 +172,11 @@ public class EvaluableScriptFactoryBean extends AbstractComponentAwareFactoryBea
 
     /**
      * {@inheritDoc}
-     * <p> We do not call the parent tear down so as to avoid any deprecation logging.
-     * </>
+     * 
+     * We do not call the parent tear down so as to avoid any deprecation logging.
      */
-    @Override protected void destroyInstance(@Nullable final EvaluableScript instance) throws Exception {
+    @Override
+    protected void destroyInstance(@Nullable final EvaluableScript instance) throws Exception {
         // No appropriate tear down, but we do not want to be called at destroy
     }
 }
\ No newline at end of file
diff --git a/shib-testing/src/main/java/net/shibboleth/shared/testing/MockExceptionCriterion.java b/shib-testing/src/main/java/net/shibboleth/shared/testing/MockExceptionCriterion.java
index 6f732977..5f5a3f51 100644
--- a/shib-testing/src/main/java/net/shibboleth/shared/testing/MockExceptionCriterion.java
+++ b/shib-testing/src/main/java/net/shibboleth/shared/testing/MockExceptionCriterion.java
@@ -27,6 +27,7 @@ import net.shibboleth.shared.resolver.ResolverException;
  */
 public class MockExceptionCriterion implements Criterion {
 
+    /** Exception too raise. */
     @Nonnull final ResolverException exception;
     
     /**

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