com.commercetools.sync.shoppinglists.helpers

Class LineItemReferenceResolver

java.lang.Object

com.commercetools.sync.commons.helpers.BaseReferenceResolver<D,S>

com.commercetools.sync.commons.helpers.CustomReferenceResolver<io.sphere.sdk.shoppinglists.LineItemDraft,io.sphere.sdk.shoppinglists.LineItemDraftBuilder,ShoppingListSyncOptions>

com.commercetools.sync.shoppinglists.helpers.LineItemReferenceResolver

public final class LineItemReferenceResolver
extends CustomReferenceResolver<io.sphere.sdk.shoppinglists.LineItemDraft,io.sphere.sdk.shoppinglists.LineItemDraftBuilder,ShoppingListSyncOptions>

Field Summary

Fields inherited from class com.commercetools.sync.commons.helpers.CustomReferenceResolver

TYPE_DOES_NOT_EXIST

Fields inherited from class com.commercetools.sync.commons.helpers.BaseReferenceResolver

BLANK_ID_VALUE_ON_REFERENCE, BLANK_KEY_VALUE_ON_RESOURCE_IDENTIFIER, options

Constructor Summary

Constructors

Constructor and Description
LineItemReferenceResolver(ShoppingListSyncOptions shoppingListSyncOptions, TypeService typeService) Takes a ShoppingListSyncOptions instance, a TypeService to instantiate a LineItemReferenceResolver instance that could be used to resolve the custom type references of the line item drafts in the CTP project specified in the injected ShoppingListSyncOptions instance.

Method Summary

Modifier and Type	Method and Description
protected java.util.concurrent.CompletionStage<io.sphere.sdk.shoppinglists.LineItemDraftBuilder>	resolveCustomTypeReference(io.sphere.sdk.shoppinglists.LineItemDraftBuilder draftBuilder) Given a draft of D (e.g.
java.util.concurrent.CompletionStage<io.sphere.sdk.shoppinglists.LineItemDraft>	resolveReferences(io.sphere.sdk.shoppinglists.LineItemDraft lineItemDraft) Given a ShoppingListDraft this method attempts to resolve the custom type reference to return a CompletionStage which contains a new instance of the draft with the resolved references.

Methods inherited from class com.commercetools.sync.commons.helpers.CustomReferenceResolver

resolveCustomTypeReference

Methods inherited from class com.commercetools.sync.commons.helpers.BaseReferenceResolver

getIdFromReference, getKeyFromResourceIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

LineItemReferenceResolver

public LineItemReferenceResolver(@Nonnull
                                 ShoppingListSyncOptions shoppingListSyncOptions,
                                 @Nonnull
                                 TypeService typeService)

Takes a ShoppingListSyncOptions instance, a TypeService to instantiate a LineItemReferenceResolver instance that could be used to resolve the custom type references of the line item drafts in the CTP project specified in the injected ShoppingListSyncOptions instance.

Parameters:

shoppingListSyncOptions - the container of all the options of the sync process including the CTP project client and/or configuration and other sync-specific options.

typeService - the service to fetch the types for reference resolution.

Method Detail

resolveReferences

@Nonnull
public java.util.concurrent.CompletionStage<io.sphere.sdk.shoppinglists.LineItemDraft> resolveReferences(@Nonnull
                                                                                                                  io.sphere.sdk.shoppinglists.LineItemDraft lineItemDraft)

Given a ShoppingListDraft this method attempts to resolve the custom type reference to return a CompletionStage which contains a new instance of the draft with the resolved references.

Specified by:

resolveReferences in class BaseReferenceResolver<io.sphere.sdk.shoppinglists.LineItemDraft,ShoppingListSyncOptions>

Parameters:

lineItemDraft - the lineItemDraft to resolve its references.

Returns:

a CompletionStage that contains as a result a new lineItemDraft instance with resolved references or, in case an error occurs during reference resolution, a ReferenceResolutionException.

resolveCustomTypeReference

@Nonnull
protected java.util.concurrent.CompletionStage<io.sphere.sdk.shoppinglists.LineItemDraftBuilder> resolveCustomTypeReference(@Nonnull
                                                                                                                                     io.sphere.sdk.shoppinglists.LineItemDraftBuilder draftBuilder)

Description copied from class: CustomReferenceResolver

Given a draft of D (e.g. CategoryDraft) this method attempts to resolve it's custom type reference to return CompletionStage which contains a new instance of the draft with the resolved custom type reference.

The method then tries to fetch the key of the custom type, optimistically from a cache. If the key is is not found, the resultant draft would remain exactly the same as the passed draft (without a custom type reference resolution).

Specified by:

resolveCustomTypeReference in class CustomReferenceResolver<io.sphere.sdk.shoppinglists.LineItemDraft,io.sphere.sdk.shoppinglists.LineItemDraftBuilder,ShoppingListSyncOptions>

Parameters:

draftBuilder - the draft builder to resolve it's references.

Returns:

a CompletionStage that contains as a result a new draft instance with resolved custom type references or, in case an error occurs during reference resolution, a ReferenceResolutionException.