#325: Add generic Javadocs.

commercetools · Nov 24, 2018 · c275a52 · c275a52
1 parent 40395f6
commit c275a52
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/main/java/com/commercetools/sync/commons/BaseSync.java b/src/main/java/com/commercetools/sync/commons/BaseSync.java
@@ -9,7 +9,14 @@
 import java.util.function.Supplier;
 
 
+/**
+ * @param <T> Resource Draft (e.g. {@link io.sphere.sdk.products.ProductDraft},
+ *             {@link io.sphere.sdk.categories.CategoryDraft}, etc..
+ * @param <U> Subclass of {@link BaseSyncStatistics}
+ * @param <V> Subclass of {@link BaseSyncOptions}
+ */
 public abstract class BaseSync<T, U extends BaseSyncStatistics, V extends BaseSyncOptions> {
+
     protected final U statistics;
     protected final V syncOptions;
 
@@ -115,6 +122,7 @@ protected static <S> S executeSupplierIfConcurrentModificationException(
         @Nonnull final Throwable sphereException,
         @Nonnull final Supplier<S> onConcurrentModificationSupplier,
         @Nonnull final Supplier<S> onOtherExceptionSupplier) {
+
         final Throwable completionExceptionCause = sphereException.getCause();
         if (completionExceptionCause instanceof ConcurrentModificationException) {
             return onConcurrentModificationSupplier.get();

diff --git a/src/main/java/com/commercetools/sync/commons/BaseSyncOptions.java b/src/main/java/com/commercetools/sync/commons/BaseSyncOptions.java
@@ -15,6 +15,11 @@
 import static com.commercetools.sync.commons.utils.CollectionUtils.emptyIfNull;
 import static java.util.Optional.ofNullable;
 
+/**
+ * @param <V> Resource Draft (e.g. {@link io.sphere.sdk.products.ProductDraft},
+ *             {@link io.sphere.sdk.categories.CategoryDraft}, etc..
+ * @param <U> Resource (e.g. {@link io.sphere.sdk.products.Product}, {@link io.sphere.sdk.categories.Category}, etc..
+ */
 public class BaseSyncOptions<U, V> {
     private final SphereClient ctpClient;
     private final BiConsumer<String, Throwable> errorCallBack;