[java-metadata-aggregator] 01/02: Javadoc fixes

[Ian Young]

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

iay pushed a commit to branch main
in repository java-metadata-aggregator.

View the commit online:
http://git.shibboleth.net/view/?p=java-metadata-aggregator.git;a=commit;h=31284b110d164585974316fc5331c8520864ea80

commit 31284b110d164585974316fc5331c8520864ea80
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Thu Aug 20 14:59:56 2020 +0100

    Javadoc fixes
---
 .../java/net/shibboleth/metadata/dom/ElementsStrippingStage.java  | 8 +++++---
 .../metadata/dom/saml/mdattr/EntityAttributeAddingStage.java      | 2 +-
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java b/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java
index 4189079..e07dee5 100644
--- a/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java
+++ b/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java
@@ -24,6 +24,7 @@ import java.util.Set;
 
 import javax.annotation.Nonnull;
 import javax.annotation.concurrent.GuardedBy;
+import javax.annotation.concurrent.Immutable;
 import javax.annotation.concurrent.ThreadSafe;
 
 import org.w3c.dom.Element;
@@ -68,6 +69,7 @@ public class ElementsStrippingStage extends AbstractDOMTraversalStage<ElementsSt
      * each of the guarded state variables from the stage class instance.
      * </p>
      */
+    @Immutable
     protected static final class Context extends SimpleDOMTraversalContext {
 
         /**
@@ -92,9 +94,9 @@ public class ElementsStrippingStage extends AbstractDOMTraversalStage<ElementsSt
          * Constructor.
          *
          * @param contextItem the {@link Item} we are traversing
-         * @param namespace 
-         * @param names 
-         * @param wl 
+         * @param namespace XML namespace for each of the elements to handle
+         * @param names collection of element names within the namespace
+         * @param wl whether the named elements should be removed (false) or preserved (true)
          */
         public Context(@Nonnull final Item<Element> contextItem,
                 @Nonnull @NotEmpty final String namespace,
diff --git a/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeAddingStage.java b/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeAddingStage.java
index 259ad21..f5c1c30 100644
--- a/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeAddingStage.java
+++ b/aggregator-pipeline/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeAddingStage.java
@@ -166,7 +166,7 @@ public class EntityAttributeAddingStage extends AbstractStage<Element> {
      * Attribute container elements.
      * 
      * @param attributes {@link List} of Attribute {@link Container}s
-     * @param matcher 
+     * @param matcher {@link Predicate} that matches the {@link Element} we are looking for
      * @return true iff the value appears somewhere in the list of containers
      */
     private boolean attributeValuePresent(@Nonnull final List<Container> attributes,

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