Package com.commercetools.sync.categories

Class CategorySync

java.lang.Object

com.commercetools.sync.commons.BaseSync<com.commercetools.api.models.category.Category,com.commercetools.api.models.category.CategoryDraft,com.commercetools.api.models.category.CategoryUpdateAction,CategorySyncStatistics,CategorySyncOptions>

com.commercetools.sync.categories.CategorySync

public class CategorySync
extends BaseSync<com.commercetools.api.models.category.Category,com.commercetools.api.models.category.CategoryDraft,com.commercetools.api.models.category.CategoryUpdateAction,CategorySyncStatistics,CategorySyncOptions>

Field Summary

Fields inherited from class com.commercetools.sync.commons.BaseSync

statistics, syncOptions

Constructor Summary

Constructors

Constructor	Description
CategorySync(CategorySyncOptions syncOptions)	Takes a CategorySyncOptions instance to instantiate a new CategorySync instance that could be used to sync category drafts with the given categories in the CTP project specified in the injected CategorySyncOptions instance.

Method Summary

Modifier and Type	Method	Description
protected java.util.concurrent.CompletionStage<CategorySyncStatistics>	process(java.util.List<com.commercetools.api.models.category.CategoryDraft> categoryDrafts)	Given a list of resource (e.g.
protected java.util.concurrent.CompletionStage<CategorySyncStatistics>	processBatch(java.util.List<com.commercetools.api.models.category.CategoryDraft> categoryDrafts)

Methods inherited from class com.commercetools.sync.commons.BaseSync

executeSupplierIfConcurrentModificationException, getStatistics, getSyncOptions, handleError, sync, syncBatches

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CategorySync

public CategorySync(@Nonnull
                    CategorySyncOptions syncOptions)

Takes a CategorySyncOptions instance to instantiate a new CategorySync instance that could be used to sync category drafts with the given categories in the CTP project specified in the injected CategorySyncOptions instance.

Parameters:

syncOptions - the container of all the options of the sync process including the CTP project client and/or configuration and other sync-specific options.

Method Detail

process

protected java.util.concurrent.CompletionStage<CategorySyncStatistics> process(@Nonnull
                                                                               java.util.List<com.commercetools.api.models.category.CategoryDraft> categoryDrafts)

Description copied from class: BaseSync

Given a list of resource (e.g. categories, products, etc..) drafts. This method compares each new resource in this list with it's corresponding old resource in a given CTP project, and in turn it either issues update actions on the existing resource if it exists or create it if it doesn't.

Specified by:

process in class BaseSync<com.commercetools.api.models.category.Category,com.commercetools.api.models.category.CategoryDraft,com.commercetools.api.models.category.CategoryUpdateAction,CategorySyncStatistics,CategorySyncOptions>

Parameters:

categoryDrafts - the list of new resources as drafts.

Returns:

an instance of CompletionStage<SyncStatisticsT> which contains as a result an instance of SyncStatisticsT which is a subclass of BaseSyncStatistics representing the statistics instance attribute of this BaseSync.

processBatch

protected java.util.concurrent.CompletionStage<CategorySyncStatistics> processBatch(@Nonnull
                                                                                    java.util.List<com.commercetools.api.models.category.CategoryDraft> categoryDrafts)

Specified by:

processBatch in class BaseSync<com.commercetools.api.models.category.Category,com.commercetools.api.models.category.CategoryDraft,com.commercetools.api.models.category.CategoryUpdateAction,CategorySyncStatistics,CategorySyncOptions>