com.commercetools.sync.commons.utils

Class CustomUpdateActionUtils

java.lang.Object

com.commercetools.sync.commons.utils.CustomUpdateActionUtils

public final class CustomUpdateActionUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CustomUpdateActionUtils()

Method Summary

Modifier and Type	Method and Description
static <T extends io.sphere.sdk.types.Custom & io.sphere.sdk.models.Resource<T>,S extends io.sphere.sdk.types.CustomDraft> java.util.List<io.sphere.sdk.commands.UpdateAction<T>>	buildCustomUpdateActions(T oldResource, S newResource, BaseSyncOptions syncOptions) Compares the CustomFields of an old resource T (for example Category, Product, etc..), to the CustomFieldsDraft, of a new resource draft S (for example CategoryDraft, ProductVariantDraft, etc..), and returns a List<UpdateAction> as a result.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUpdateActionUtils

public CustomUpdateActionUtils()

Method Detail

buildCustomUpdateActions

@Nonnull
public static <T extends io.sphere.sdk.types.Custom & io.sphere.sdk.models.Resource<T>,S extends io.sphere.sdk.types.CustomDraft> java.util.List<io.sphere.sdk.commands.UpdateAction<T>> buildCustomUpdateActions(@Nonnull
                                                                                                                                                                                                                           T oldResource,
                                                                                                                                                                                                                           @Nonnull
                                                                                                                                                                                                                           S newResource,
                                                                                                                                                                                                                           @Nonnull
                                                                                                                                                                                                                           BaseSyncOptions syncOptions)

Compares the CustomFields of an old resource T (for example Category, Product, etc..), to the CustomFieldsDraft, of a new resource draft S (for example CategoryDraft, ProductVariantDraft, etc..), and returns a List<UpdateAction> as a result. If no update action is needed, for example in the case where both the CustomFields and the CustomFieldsDraft are null, an empty List<UpdateAction> is returned. A BaseSyncOptions instance is injected into the method which is responsible for supplying the sync options to the sync utility method. For example, custom error callbacks for errors. The TypeService is injected also for fetching the key of the old resource type from it's cache (see buildNonNullCustomFieldsUpdateActions(CustomFields, CustomFieldsDraft, Custom, BaseSyncOptions)).

An update action will be added to the result list in the following cases:-

1. If the new resources's custom type is set, but old resources's custom type is not. A "setCustomType" update actions is added, which sets the custom type (and all it's fields to the old resource).
2. If the new resource's custom type is not set, but the old resource's custom type is set. A "setCustomType" update action is added, which removes the type set on the old resource.
3. If both the resources custom types are the same and the custom fields are both set. The custom field values of both resources are then calculated. (see buildSetCustomFieldsUpdateActions(Map, Map, Custom, BaseSyncOptions))
4. If the keys of both custom types are different, then a "setCustomType" update action is added, where the old resource's custom type is set to be as the new one's.
5. If both resources custom type keys are identical but the custom fields of the new resource's custom type is not set.

An update action will not be added to the result list in the following cases:-

1. If both the resources' custom types are not set.
2. If both the resources' custom type keys are not set.
3. Custom fields are both empty.
4. Custom field JSON values have different ordering.
5. Custom field values are identical.

Type Parameters:

T - the type of the Resource

S - the subtype of the CustomDraft

Parameters:

oldResource - the resource which should be updated.

newResource - the resource draft where we get the new custom fields.

syncOptions - responsible for supplying the sync options to the sync utility method.

Returns:

a list that contains all the update actions needed, otherwise an empty list if no update actions are needed.