com.commercetools.sync.categories

Class CategorySyncOptionsBuilder

java.lang.Object

com.commercetools.sync.commons.BaseSyncOptionsBuilder<CategorySyncOptionsBuilder,CategorySyncOptions>

com.commercetools.sync.categories.CategorySyncOptionsBuilder

public final class CategorySyncOptionsBuilder
extends BaseSyncOptionsBuilder<CategorySyncOptionsBuilder,CategorySyncOptions>

Field Summary

Fields

Modifier and Type	Field and Description
static int	BATCH_SIZE_DEFAULT

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

allowUuid, batchSize, ctpClient, errorCallBack, removeOtherCollectionEntries, removeOtherLocales, removeOtherProperties, removeOtherSetEntries, warningCallBack

Method Summary

Modifier and Type	Method and Description
CategorySyncOptions	build() Creates new instance of CategorySyncOptions enriched with all attributes provided to this builder.
protected CategorySyncOptionsBuilder	getThis() Returns an instance of this class to be used in the super class generic methods.
static CategorySyncOptionsBuilder	of(io.sphere.sdk.client.SphereClient ctpClient) Creates a new instance of CategorySyncOptionsBuilder given a SphereClient responsible for interaction with the target CTP project, with the dafult batch size (BATCH_SIZE_DEFAULT = 50).
CategorySyncOptionsBuilder	setUpdateActionsFilter(java.util.function.Function<java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>,java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>> updateActionsFilter) Sets the updateActions filter function which can be applied on generated list of update actions to produce a resultant list after the filter function has been applied.

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

setAllowUuidKeys, setBatchSize, setErrorCallBack, setRemoveOtherCollectionEntries, setRemoveOtherLocales, setRemoveOtherProperties, setRemoveOtherSetEntries, setWarningCallBack

Methods inherited from class java.lang.Object

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

Field Detail

BATCH_SIZE_DEFAULT

public static final int BATCH_SIZE_DEFAULT

See Also:

Constant Field Values

Method Detail

of

public static CategorySyncOptionsBuilder of(@Nonnull
                                            io.sphere.sdk.client.SphereClient ctpClient)

Creates a new instance of CategorySyncOptionsBuilder given a SphereClient responsible for interaction with the target CTP project, with the dafult batch size (BATCH_SIZE_DEFAULT = 50).

Parameters:

ctpClient - instance of the SphereClient responsible for interaction with the target CTP project.

Returns:

new instance of CategorySyncOptionsBuilder

setUpdateActionsFilter

public CategorySyncOptionsBuilder setUpdateActionsFilter(@Nonnull
                                                         java.util.function.Function<java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>,java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>> updateActionsFilter)

Sets the updateActions filter function which can be applied on generated list of update actions to produce a resultant list after the filter function has been applied.

Parameters:

updateActionsFilter - filter function which can be applied on generated list of update actions

Returns:

this instance of CategorySyncOptionsBuilder

build

public CategorySyncOptions build()

Creates new instance of CategorySyncOptions enriched with all attributes provided to this builder.

Specified by:

build in class BaseSyncOptionsBuilder<CategorySyncOptionsBuilder,CategorySyncOptions>

Returns:

new instance of CategorySyncOptions

getThis

protected CategorySyncOptionsBuilder getThis()

Returns an instance of this class to be used in the super class generic methods. Please see the JavaDoc in the overridden method for further details.

Specified by:

getThis in class BaseSyncOptionsBuilder<CategorySyncOptionsBuilder,CategorySyncOptions>

Returns:

an instance of this class.