[java-metadata-aggregator] branch main updated: Improve (and correct) Javadoc

[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=5f03bb1a629463d2cc7631b8622b34045a4bfb60

The following commit(s) were added to refs/heads/main by this push:
     new 5f03bb1  Improve (and correct) Javadoc
5f03bb1 is described below

commit 5f03bb1a629463d2cc7631b8622b34045a4bfb60
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Tue Jan 31 08:12:13 2023 +0000

    Improve (and correct) Javadoc
---
 .../metadata/pipeline/SplitMergeStage.java         | 35 +++++++++++++++-------
 1 file changed, 24 insertions(+), 11 deletions(-)

diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/pipeline/SplitMergeStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/pipeline/SplitMergeStage.java
index ed5a0db..d95c04d 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/pipeline/SplitMergeStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/pipeline/SplitMergeStage.java
@@ -43,25 +43,38 @@ import net.shibboleth.shared.component.ComponentInitializationException;
 import net.shibboleth.shared.logic.Constraint;
 
 /**
- * A stage which splits a given collection and passes selected items to one pipeline and non-selected items to another.
- * The selected and non-selected item pipelines are executed via the set {@link ExecutorService} and operate on
- * collections that contains clones of the (non-)selected items.
- * 
+ * A stage which splits a given collection according to a provided selection strategy
+ * and passes selected items to one pipeline and non-selected items to another.
+ *
+ * <p>
+ * The selected and non-selected item pipelines are executed via the set {@link ExecutorService}.
+ * </p>
+ *
+ * <p>
+ * The results of the two pipelines are merged to produce the result.
+ * </p>
+ *
  * <p>
  * This stage requires the following properties be set prior to initialization:
+ * </p>
+ *
  * <ul>
  * <li><code>selectionStrategy</code></li>
  * <li><code>selectedItemPipeline</code> or <code>nonselectedItemPipeline</code></li>
  * </ul>
- * 
+ *
+ * <p>
+ * If no {@link #executorService} is provided, one will be created using {@link Executors#newSingleThreadExecutor()}.
+ * </p>
+ *
  * <p>
- * If no {@link #executorService} is provided, one will be created using {@link Executors#newFixedThreadPool(int)} with
- * 6 threads.
- * 
  * If no {@link #collectionFactory} is given, then {@link SimpleItemCollectionFactory} is used.
- * 
- * If one or the other pipeline is null then no objects will be passed to it (obviously).
- * 
+ * </p>
+ *
+ * <p>
+ * If one or the other pipeline is <code>null</code> then no objects will be passed to it (obviously).
+ * </p>
+ *
  * @param <T> type of items upon which this stage operates
  */
 @ThreadSafe

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