com.commercetools.sync.products.ProductSyncOptionsBuilder Maven / Gradle / Ivy

Go to download
package com.commercetools.sync.products;

import com.commercetools.api.client.ProjectApiRoot;
import com.commercetools.api.models.product.ProductDraft;
import com.commercetools.api.models.product.ProductProjection;
import com.commercetools.api.models.product.ProductUpdateAction;
import com.commercetools.sync.commons.BaseSyncOptionsBuilder;
import javax.annotation.Nonnull;

public final class ProductSyncOptionsBuilder
    extends BaseSyncOptionsBuilder<
        ProductSyncOptionsBuilder,
        ProductSyncOptions,
        ProductProjection,
        ProductDraft,
        ProductUpdateAction> {
  public static final int BATCH_SIZE_DEFAULT = 30;
  private SyncFilter syncFilter;
  static final boolean ENSURE_CHANNELS_DEFAULT = false;
  private boolean ensurePriceChannels = ENSURE_CHANNELS_DEFAULT;

  private ProductSyncOptionsBuilder(final ProjectApiRoot ctpClient) {
    this.ctpClient = ctpClient;
  }

  public static ProductSyncOptionsBuilder of(@Nonnull final ProjectApiRoot ctpClient) {
    return new ProductSyncOptionsBuilder(ctpClient).batchSize(BATCH_SIZE_DEFAULT);
  }

  /**
   * Set option that defines {@link SyncFilter} for the sync, which defines either a blacklist or a
   * whitelist for filtering certain update action groups.
   *
   * The action groups can be a list of any of the values of the enum {@link ActionGroup},
   * namely:
   *
   * 

   *   ATTRIBUTES
   *   
PRICES
   *   
IMAGES
   *   
CATEGORIES
   *   
.. and others
   * 
   *
   * @param syncFilter defines either a blacklist or a whitelist for filtering certain update action
   *     groups.
   * @return {@code this} instance of {@link ProductSyncOptionsBuilder}
   */
  @Nonnull
  public ProductSyncOptionsBuilder syncFilter(@Nonnull final SyncFilter syncFilter) {
    this.syncFilter = syncFilter;
    return this;
  }

  /**
   * Set option that indicates whether sync process should create a price channel of given key when
   * it doesn't exist in a target project yet. If set to {@code true}, the sync process would try to
   * create the new price channel of the given key, otherwise the sync process would log an error
   * and fail to process the draft with the given price channel key.
   *
   * This property is {@link ProductSyncOptionsBuilder#ENSURE_CHANNELS_DEFAULT} by default.
   *
   * @param ensurePriceChannels boolean that indicates whether sync process should create price
   *     channel of given key when it doesn't exist in a target project yet
   * @return {@code this} instance of {@link ProductSyncOptionsBuilder}
   */
  @Nonnull
  public ProductSyncOptionsBuilder ensurePriceChannels(final boolean ensurePriceChannels) {
    this.ensurePriceChannels = ensurePriceChannels;
    return this;
  }

  @Override
  @Nonnull
  public ProductSyncOptions build() {
    return new ProductSyncOptions(
        ctpClient,
        errorCallback,
        warningCallback,
        batchSize,
        syncFilter,
        beforeUpdateCallback,
        beforeCreateCallback,
        cacheSize,
        ensurePriceChannels);
  }

  @Override
  protected ProductSyncOptionsBuilder getThis() {
    return this;
  }
}