com.commercetools.sync.commons

Class BaseSyncOptionsBuilder<T extends BaseSyncOptionsBuilder<T,S>,S extends BaseSyncOptions>

java.lang.Object

com.commercetools.sync.commons.BaseSyncOptionsBuilder<T,S>

Direct Known Subclasses:

CategorySyncOptionsBuilder, InventorySyncOptionsBuilder, ProductSyncOptionsBuilder

public abstract class BaseSyncOptionsBuilder<T extends BaseSyncOptionsBuilder<T,S>,S extends BaseSyncOptions>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowUuid
protected int	batchSize
protected io.sphere.sdk.client.SphereClient	ctpClient
protected java.util.function.BiConsumer<java.lang.String,java.lang.Throwable>	errorCallBack
protected boolean	removeOtherCollectionEntries
protected boolean	removeOtherLocales
protected boolean	removeOtherProperties
protected boolean	removeOtherSetEntries
protected java.util.function.Consumer<java.lang.String>	warningCallBack

Constructor Summary

Constructors

Constructor and Description
BaseSyncOptionsBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract S	build() Creates new instance of S which extends BaseSyncOptions enriched with all attributes provided to this builder.
protected abstract T	getThis() Returns this instance of T, which extends BaseSyncOptionsBuilder.
T	setAllowUuidKeys(boolean allowUuid) The sync expects the user to pass the keys to references in the id field of References.
T	setBatchSize(int batchSize) Set option that indicates batch size for sync process.
T	setErrorCallBack(java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> errorCallBack) Sets the errorCallBack function of the sync module.
T	setRemoveOtherCollectionEntries(boolean removeOtherCollectionEntries) Sets the removeOtherSetEntries boolean flag which adds collection (e.g.
T	setRemoveOtherLocales(boolean removeOtherLocales) Sets the removeOtherLocales boolean flag which adds additional localizations without deleting existing ones.
T	setRemoveOtherProperties(boolean removeOtherProperties) Sets the removeOtherProperties boolean flag which adds additional object properties (e.g.
T	setRemoveOtherSetEntries(boolean removeOtherSetEntries) Sets the removeOtherSetEntries boolean flag which adds additional Set entries without deleting existing ones.
T	setWarningCallBack(java.util.function.Consumer<java.lang.String> warningCallBack) Sets the warningCallBack function of the sync module.

Methods inherited from class java.lang.Object

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

Field Detail

ctpClient

protected io.sphere.sdk.client.SphereClient ctpClient

errorCallBack

protected java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> errorCallBack

warningCallBack

protected java.util.function.Consumer<java.lang.String> warningCallBack

batchSize

protected int batchSize

removeOtherLocales

protected boolean removeOtherLocales

removeOtherSetEntries

protected boolean removeOtherSetEntries

removeOtherCollectionEntries

protected boolean removeOtherCollectionEntries

removeOtherProperties

protected boolean removeOtherProperties

allowUuid

protected boolean allowUuid

Constructor Detail

BaseSyncOptionsBuilder

public BaseSyncOptionsBuilder()

Method Detail

setErrorCallBack

public T setErrorCallBack(@Nonnull
                          java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> errorCallBack)

Sets the errorCallBack function of the sync module. This callback will be called whenever an event occurs that leads to an error alert from the sync process.

Parameters:

errorCallBack - the new value to set to the error callback.

Returns:

this instance of BaseSyncOptionsBuilder

setWarningCallBack

public T setWarningCallBack(@Nonnull
                            java.util.function.Consumer<java.lang.String> warningCallBack)

Sets the warningCallBack function of the sync module. This callback will be called whenever an event occurs that leads to a warning alert from the sync process.

Parameters:

warningCallBack - the new value to set to the warning callback.

Returns:

this instance of BaseSyncOptionsBuilder

setBatchSize

public T setBatchSize(int batchSize)

Set option that indicates batch size for sync process. During the sync there is a need for fetching existing resources so that they can be compared with the new resource drafts. That's why the input is sliced into batches and then processed. It allows to reduce the query size for fetching all resources processed in one batch. E.g. value of 30 means that 30 entries from input list would be accumulated and one API call will be performed for fetching entries responding to them. Then comparision and sync are performed.

This batch size is set to 30 by default.

Parameters:

batchSize - int that indicates batch size of resources to process. Has to be positive or else will be ignored and default value of 30 would be used.

Returns:

this instance of BaseSyncOptionsBuilder

setRemoveOtherLocales

public T setRemoveOtherLocales(boolean removeOtherLocales)

Sets the removeOtherLocales boolean flag which adds additional localizations without deleting existing ones. If set to true, which is the default value of the option, it deletes the existing localizations. If set to false, it doesn't delete the existing ones.

Parameters:

removeOtherLocales - new value to set to the boolean flag.

Returns:

this instance of BaseSyncOptionsBuilder

setRemoveOtherSetEntries

public T setRemoveOtherSetEntries(boolean removeOtherSetEntries)

Sets the removeOtherSetEntries boolean flag which adds additional Set entries without deleting existing ones. If set to true, which is the default value of the option, it deletes the existing Set entries. If set to false, it doesn't delete the existing ones.

Parameters:

removeOtherSetEntries - new value to set to the boolean flag.

Returns:

this instance of BaseSyncOptionsBuilder

setRemoveOtherCollectionEntries

public T setRemoveOtherCollectionEntries(boolean removeOtherCollectionEntries)

Sets the removeOtherSetEntries boolean flag which adds collection (e.g. Assets, Images etc.) entries without deleting existing ones. If set to true, which is the default value of the option, it deletes the existing collection entries. If set to false, it doesn't delete the existing ones.

Parameters:

removeOtherCollectionEntries - new value to set to the boolean flag.

Returns:

this instance of BaseSyncOptionsBuilder

setRemoveOtherProperties

public T setRemoveOtherProperties(boolean removeOtherProperties)

Sets the removeOtherProperties boolean flag which adds additional object properties (e.g. custom fields, product attributes, etc..) without deleting existing ones. If set to true, which is the default value of the option, it deletes the existing object properties. If set to false, it doesn't delete the existing ones.

Parameters:

removeOtherProperties - new value to set to the boolean flag.

Returns:

this instance of BaseSyncOptionsBuilder

setAllowUuidKeys

public T setAllowUuidKeys(boolean allowUuid)

The sync expects the user to pass the keys to references in the id field of References. If the key values are in UUID format, then this flag must be set to true, otherwise the sync will fail to resolve the reference. This flag, if set to true, enables the user to use keys with UUID format. By default, it is set to false.

Parameters:

allowUuid - new vale to set to the boolean flag.

Returns:

this instance of BaseSyncOptionsBuilder

build

protected abstract S build()

Creates new instance of S which extends BaseSyncOptions enriched with all attributes provided to this builder.

Returns:

new instance of S which extends BaseSyncOptions

getThis

protected abstract T getThis()

Returns this instance of T, which extends BaseSyncOptionsBuilder. The purpose of this method is to make sure that this is an instance of a class which extends BaseSyncOptionsBuilder in order to be used in the generic methods of the class. Otherwise, without this method, the methods above would need to cast this to T which could lead to a runtime error of the class was extended in a wrong way.

Returns:

an instance of the class that overrides this method.