deprecating uk.ac.ebi.utils.threading.batchproc.

marco-brandizi · Nov 6, 2023 · eda1908 · eda1908
1 parent f8e48e1
commit eda1908
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 5 deletions.
diff --git a/revision-history.md b/revision-history.md
@@ -1,10 +1,13 @@
 # Revision History
 
-*This file was last revised on 2023-08-15*. **Please keep this note updated**.
+*This file was last revised on 2023-11-06*. **Please keep this note updated**.
 
 ## 14.0-SNAPSHOT
-* Old classes removed
-* `CollectionsUtils` added
+* `CollectionsUtils` added.
+* `Xvalidate` added.
+* Some old classes removed: `Pair`.
+* the `uk.ac.ebi.utils.threading.batchproc` package has been deprecated, since the same functionality is offered by [Project Reactor](https://projectreactor.io/). [Example](https://www.baeldung.com/java-stream-batch-processing#reactor).
+
 
 ## 13.0
 * **These migrations are incompatible with older versions**:

diff --git a/src/main/java/uk/ac/ebi/utils/threading/batchproc/AbstractSizedBatchCollector.java b/src/main/java/uk/ac/ebi/utils/threading/batchproc/AbstractSizedBatchCollector.java
@@ -8,7 +8,11 @@
  * <dl><dt>Date:</dt><dd>25 Nov 2019</dd></dl>
  *
  * @param <B>
+ * 
+ * @deprecated the functionality available in this package is provided by project 
+ * Reactor and we recommend to switch to that. TODO: helpers and examples about batching via Reactor.
  */
+@Deprecated
 public abstract class AbstractSizedBatchCollector<B> implements SizedBatchCollector<B>
 {
 	private long maxBatchSize = 1000;

diff --git a/src/main/java/uk/ac/ebi/utils/threading/batchproc/BatchCollector.java b/src/main/java/uk/ac/ebi/utils/threading/batchproc/BatchCollector.java
@@ -5,7 +5,7 @@
 import java.util.stream.Collector;
 
 /**
- * ## The Batch Collector
+ * <h1>The Batch Collector</h1>
  * 
  * A batch collector is a container of methods to manage batches during the operations of 
  * {@link BatchProcessor}. This default interface offers a {@link #batchFactory() batch factory}, used
@@ -22,7 +22,10 @@
  * @author brandizi
  * <dl><dt>Date:</dt><dd>23 Nov 2019</dd></dl>
  *
+ * @deprecated the functionality available in this package is provided by project 
+ * Reactor and we recommend to switch to that. TODO: helpers and examples about batching via Reactor.
  */
+@Deprecated
 public interface BatchCollector<B>
 {
 	public abstract Supplier<B> batchFactory();

diff --git a/src/main/java/uk/ac/ebi/utils/threading/batchproc/BatchProcessor.java b/src/main/java/uk/ac/ebi/utils/threading/batchproc/BatchProcessor.java
@@ -19,7 +19,7 @@
 
 
 /**  
- * ## Batch Processor Skeleton 
+ * <h1>Batch Processor Skeleton</h1> 
  * 
  * A simple skeleton to manage processing of data in multi-thread mode.  
  * 
@@ -65,7 +65,10 @@
  * @author brandizi
  * <dl><dt>Date:</dt><dd>1 Dec 2017</dd></dl>
  *
+ * @deprecated the functionality available in this package is provided by project 
+ * Reactor and we recommend to switch to that. TODO: helpers and examples about batching via Reactor.
  */
+@Deprecated
 public abstract class BatchProcessor<B, BC extends BatchCollector<B>, BJ extends Consumer<B>>
 {
 	private BJ batchJob;

diff --git a/src/main/java/uk/ac/ebi/utils/threading/batchproc/ItemizedBatchCollector.java b/src/main/java/uk/ac/ebi/utils/threading/batchproc/ItemizedBatchCollector.java
@@ -11,7 +11,10 @@
  * @author brandizi
  * <dl><dt>Date:</dt><dd>23 Nov 2019</dd></dl>
  *
+ * @deprecated the functionality available in this package is provided by project 
+ * Reactor and we recommend to switch to that. TODO: helpers and examples about batching via Reactor.
  */
+@Deprecated
 public interface ItemizedBatchCollector<B,E> extends BatchCollector<B>
 {
 	public BiConsumer<B, E> accumulator();

diff --git a/src/main/java/uk/ac/ebi/utils/threading/batchproc/ItemizedBatchProcessor.java b/src/main/java/uk/ac/ebi/utils/threading/batchproc/ItemizedBatchProcessor.java
@@ -17,7 +17,10 @@
  * @author brandizi
  * <dl><dt>Date:</dt><dd>23 Nov 2019</dd></dl>
  *
+ * @deprecated the functionality available in this package is provided by project 
+ * Reactor and we recommend to switch to that. TODO: helpers and examples about batching via Reactor.
  */
+@Deprecated
 public abstract class ItemizedBatchProcessor<E, B, BC extends ItemizedBatchCollector<B,E>, BJ extends Consumer<B>> 
   extends BatchProcessor<B, BC, BJ>
 {

diff --git a/src/main/java/uk/ac/ebi/utils/threading/batchproc/ItemizedSizedBatchCollector.java b/src/main/java/uk/ac/ebi/utils/threading/batchproc/ItemizedSizedBatchCollector.java
@@ -7,7 +7,10 @@
  * @author brandizi
  * <dl><dt>Date:</dt><dd>23 Nov 2019</dd></dl>
  *
+ * @deprecated the functionality available in this package is provided by project 
+ * Reactor and we recommend to switch to that. TODO: helpers and examples about batching via Reactor.
  */
+@Deprecated
 public interface ItemizedSizedBatchCollector<B,E> 
 	extends ItemizedBatchCollector<B, E>, SizedBatchCollector<B>
 {

diff --git a/src/main/java/uk/ac/ebi/utils/threading/batchproc/SizedBatchCollector.java b/src/main/java/uk/ac/ebi/utils/threading/batchproc/SizedBatchCollector.java
@@ -10,7 +10,10 @@
  * @author brandizi
  * <dl><dt>Date:</dt><dd>23 Nov 2019</dd></dl>
  *
+ * @deprecated the functionality available in this package is provided by project 
+ * Reactor and we recommend to switch to that. TODO: helpers and examples about batching via Reactor.
  */
+@Deprecated
 public interface SizedBatchCollector<B> extends BatchCollector<B>
 {
 	public abstract Function<B,Long> batchSizer ();