com.commercetools.sync.types.utils

Class TypeSyncUtils

java.lang.Object

com.commercetools.sync.types.utils.TypeSyncUtils

public final class TypeSyncUtils
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.types.Type>>	buildActions(io.sphere.sdk.types.Type oldType, io.sphere.sdk.types.TypeDraft newType, TypeSyncOptions syncOptions) Compares all the fields (including the field definitions see TypeUpdateActionUtils.buildFieldDefinitionsUpdateActions(Type, TypeDraft, TypeSyncOptions)) of a Type and a TypeDraft.

Methods inherited from class java.lang.Object

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

Method Detail

buildActions

@Nonnull
public static java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.types.Type>> buildActions(@Nonnull
                                                                                                                  io.sphere.sdk.types.Type oldType,
                                                                                                                  @Nonnull
                                                                                                                  io.sphere.sdk.types.TypeDraft newType,
                                                                                                                  @Nonnull
                                                                                                                  TypeSyncOptions syncOptions)

Compares all the fields (including the field definitions see TypeUpdateActionUtils.buildFieldDefinitionsUpdateActions(Type, TypeDraft, TypeSyncOptions)) of a Type and a TypeDraft. It returns a List of UpdateAction<Type> as a result. If no update actions are needed, for example in case where both the Type and the TypeDraft have the same fields, an empty List is returned.

Note: Currently this util doesn't support the following:

• updating the inputHint of a FieldDefinition
• removing the EnumValue/LocalizedEnumValue of a FieldDefinition
• updating the label of a EnumValue/LocalizedEnumValue of a FieldDefinition

Parameters:

oldType - the Type which should be updated.

newType - the TypeDraft where we get the new data.

syncOptions - the sync options wrapper which contains options related to the sync process supplied by the user. For example, custom callbacks to call in case of warnings or errors occurring on the build update action process. And other options (See TypeSyncOptions for more info.

Returns:

A list of type-specific update actions.