Package com.commercetools.sync.types

Class TypeSync

java.lang.Object

com.commercetools.sync.commons.BaseSync<io.sphere.sdk.types.TypeDraft,TypeSyncStatistics,TypeSyncOptions>

com.commercetools.sync.types.TypeSync

public class TypeSync
extends BaseSync<io.sphere.sdk.types.TypeDraft,TypeSyncStatistics,TypeSyncOptions>

This class syncs type drafts with the corresponding types in the CTP project.

Field Summary

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

statistics, syncOptions

Constructor Summary

Constructors

Constructor	Description
TypeSync(TypeSyncOptions typeSyncOptions)

Method Summary

Modifier and Type	Method	Description
protected java.util.concurrent.CompletionStage<TypeSyncStatistics>	process(java.util.List<io.sphere.sdk.types.TypeDraft> typeDrafts)	Iterates through the whole typeDrafts list and accumulates its valid drafts to batches.
protected java.util.concurrent.CompletionStage<TypeSyncStatistics>	processBatch(java.util.List<io.sphere.sdk.types.TypeDraft> batch)	This method first creates a new Set of valid TypeDraft elements.

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

executeSupplierIfConcurrentModificationException, getStatistics, getSyncOptions, sync, syncBatches

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeSync

public TypeSync(@Nonnull
                TypeSyncOptions typeSyncOptions)

Method Detail

process

protected java.util.concurrent.CompletionStage<TypeSyncStatistics> process(@Nonnull
                                                                           java.util.List<io.sphere.sdk.types.TypeDraft> typeDrafts)

Iterates through the whole typeDrafts list and accumulates its valid drafts to batches. Every batch is then processed by processBatch(List).

Inherited doc: 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<io.sphere.sdk.types.TypeDraft,TypeSyncStatistics,TypeSyncOptions>

Parameters:

typeDrafts - List of TypeDraft's that would be synced into CTP project.

Returns:

CompletionStage with TypeSyncStatistics holding statistics of all sync processes performed by this sync instance.

processBatch

protected java.util.concurrent.CompletionStage<TypeSyncStatistics> processBatch(@Nonnull
                                                                                java.util.List<io.sphere.sdk.types.TypeDraft> batch)

This method first creates a new Set of valid TypeDraft elements. For more on the rules of validation, check: TypeBatchValidator.validateAndCollectReferencedKeys(List). Using the resulting set of validTypeDrafts, the matching types in the target CTP project are fetched then the method syncBatch(Set, Set) is called to perform the sync (update or create requests accordingly) on the target project.

In case of error during of fetching of existing types, the error callback will be triggered. And the sync process would stop for the given batch.

Specified by:

processBatch in class BaseSync<io.sphere.sdk.types.TypeDraft,TypeSyncStatistics,TypeSyncOptions>

Parameters:

batch - batch of drafts that need to be synced

Returns:

a CompletionStage containing an instance of TypeSyncStatistics which contains information about the result of syncing the supplied batch to the target project.