com.commercetools.sync.commons.helpers

Class GenericCustomActionBuilder<T extends io.sphere.sdk.types.Custom & io.sphere.sdk.models.Resource<T>>

java.lang.Object

com.commercetools.sync.commons.helpers.GenericCustomActionBuilder<T>

Type Parameters:

T - the type of the resource to create update actions for.

Direct Known Subclasses:

CategoryCustomActionBuilder, ChannelCustomActionBuilder, InventoryCustomActionBuilder

public abstract class GenericCustomActionBuilder<T extends io.sphere.sdk.types.Custom & io.sphere.sdk.models.Resource<T>>
extends java.lang.Object

A Generic Custom update action builder that creates update actions that are of the same type as the Generic type T provided by the subclass of this abstract class. For example, if the subclass has T as Category then all the methods would build custom update actions of the type Category

Constructor Summary

Constructors

Constructor and Description
GenericCustomActionBuilder()

Method Summary

Modifier and Type	Method and Description
abstract io.sphere.sdk.commands.UpdateAction<T>	buildRemoveCustomTypeAction() Creates a CTP "setCustomType" update action on the given resource T that removes the custom type set on the given resource T (which currently could either be a Category or a Channel).
abstract io.sphere.sdk.commands.UpdateAction<T>	buildSetCustomFieldAction(java.lang.String customFieldName, com.fasterxml.jackson.databind.JsonNode customFieldValue) Creates a CTP "setCustomField" update action on the given resource T that updates a custom field with customFieldName and a customFieldValue on the given resource T (which currently could either be a Category or a Channel).
abstract io.sphere.sdk.commands.UpdateAction<T>	buildSetCustomTypeAction(java.lang.String customTypeId, java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> customFieldsJsonMap) Creates a CTP "setCustomType" update action on the given resource T (which currently could either be a Category or a Channel).

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericCustomActionBuilder

public GenericCustomActionBuilder()

Method Detail

buildRemoveCustomTypeAction

@Nonnull
public abstract io.sphere.sdk.commands.UpdateAction<T> buildRemoveCustomTypeAction()

Creates a CTP "setCustomType" update action on the given resource T that removes the custom type set on the given resource T (which currently could either be a Category or a Channel).

Returns:

a setCustomType update action that removes the custom type from the resource it's requested on.

buildSetCustomTypeAction

@Nonnull
public abstract io.sphere.sdk.commands.UpdateAction<T> buildSetCustomTypeAction(@Nullable
                                                                                         java.lang.String customTypeId,
                                                                                         @Nullable
                                                                                         java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> customFieldsJsonMap)

Creates a CTP "setCustomType" update action on the given resource T (which currently could either be a Category or a Channel).

Parameters:

customTypeId - the id of the new custom type.

customFieldsJsonMap - the custom fields map of JSON values.

Returns:

a setCustomType update action of the type of the resource it's requested on.

buildSetCustomFieldAction

@Nonnull
public abstract io.sphere.sdk.commands.UpdateAction<T> buildSetCustomFieldAction(@Nullable
                                                                                          java.lang.String customFieldName,
                                                                                          @Nullable
                                                                                          com.fasterxml.jackson.databind.JsonNode customFieldValue)

Creates a CTP "setCustomField" update action on the given resource T that updates a custom field with customFieldName and a customFieldValue on the given resource T (which currently could either be a Category or a Channel).

Parameters:

customFieldName - the name of the custom field to update.

customFieldValue - the new JSON value of the custom field.

Returns:

a setCustomField update action on the provided field name, with the provided value on the resource it's requested on.