[java-oidc-common] branch main updated: More javadoc fixes

[Rod Widdowson]

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

rdw pushed a commit to branch main
in repository java-oidc-common.

View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=6a83341f3b7204ce1c0463b7a8b33ffeb36cda52

The following commit(s) were added to refs/heads/main by this push:
     new 6a83341  More javadoc fixes
6a83341 is described below

commit 6a83341f3b7204ce1c0463b7a8b33ffeb36cda52
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Thu Jan 27 15:44:16 2022 +0000

    More javadoc fixes
---
 .../oidc/metadata/cache/impl/BatchMetadataCacheBuilder.java        | 2 +-
 .../shibboleth/oidc/metadata/cache/impl/DynamicMetadataCache.java  | 7 +++----
 .../oidc/metadata/cache/impl/DynamicMetadataCacheBuilder.java      | 2 +-
 .../oidc/metadata/impl/AbstractOIDCMetadataResolver.java           | 4 +++-
 4 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilder.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilder.java
index fd84e19..a0ed4f4 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilder.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilder.java
@@ -42,7 +42,7 @@ public final class BatchMetadataCacheBuilder  {
      * A static builder for generating a batch metadata cache from a given specification.
      *
      * @param <IdentifierType> The identifier type 
-     * @param <MetadataType> The metadata type>
+     * @param <MetadataType> The metadata type
      */
     public static class Builder<IdentifierType, MetadataType> {
         
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCache.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCache.java
index 1eb839d..35d0570 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCache.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCache.java
@@ -76,7 +76,7 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
 public class DynamicMetadataCache<IdentifierType, MetadataType> 
                             extends AbstractMetadataCache<IdentifierType, MetadataType> {
     
-    /** Metric name for the timer for {@link #resolve(CriteriaSet)}. */
+    /** Metric name for the timer for {@link #get(CriteriaSet)}. */
     public static final String METRIC_TIMER_GET = "timer.get";
     
     /** Metric name for the gauge of the number of live entityIDs. */
@@ -133,7 +133,7 @@ public class DynamicMetadataCache<IdentifierType, MetadataType>
     
     /** Metrics Gauge for the number of live indexed metadata.*/
     @Nullable private Gauge<Integer> gaugeNumLiveIndexedMetadata;
-    
+
     /** 
      * Constructor.
      *
@@ -651,8 +651,7 @@ public class DynamicMetadataCache<IdentifierType, MetadataType>
         }
         
         /**
-         *  Purge metadata which is either 1) expired or 2) (if {@link #isRemoveIdleEntityData()} is true) 
-         *  which hasn't been accessed within the last {@link #getMaxIdleEntityData()} duration.
+         *  Purge metadata if {@link #isRemoveData(MetadataManagementData, Instant, Instant)} is true)
          */
         private void removeExpiredAndIdleMetadata() {
             final Instant now = Instant.now();
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCacheBuilder.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCacheBuilder.java
index 5fad0b7..2992abf 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCacheBuilder.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DynamicMetadataCacheBuilder.java
@@ -41,7 +41,7 @@ public final class DynamicMetadataCacheBuilder {
      * A static builder for generating a dynamic metadata cache from a given specification.
      *
      * @param <IdentifierType> The identifier type 
-     * @param <MetadataType> The metadata type>
+     * @param <MetadataType> The metadata type
      */
     public static class Builder<IdentifierType, MetadataType> {
 
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCMetadataResolver.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCMetadataResolver.java
index 013935d..4d8644d 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCMetadataResolver.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCMetadataResolver.java
@@ -291,7 +291,9 @@ public abstract class AbstractOIDCMetadataResolver<MetadataIdentifier, MetadataT
         }
     }
     
-    /** Initialise this metadata provider. Subclasses will need to override this method.*/
+    /** Initialise this metadata provider. Subclasses will need to override this method.
+     * @throws ComponentInitializationException if initialization fails.
+     */
     protected abstract void initMetadataResolver() throws ComponentInitializationException;
     
 

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