io.sphere.sdk.commands

Class MetaModelUpdateCommandDslImpl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>,E>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.CommandImpl<T>

io.sphere.sdk.commands.MetaModelUpdateCommandDslImpl<T,C,E>

Type Parameters:

T - the type of the result of the command

C - class which will serialized as JSON command body, most likely a template

E - type of the expansion model

All Implemented Interfaces:

SphereRequest<T>, Command<T>, UpdateCommand<T>, UpdateCommandDsl<T,C>, ExpansionPathContainer<T>, MetaModelExpansionDslExpansionModelRead<T,C,E>, MetaModelReferenceExpansionDsl<T,C,E>, ReferenceExpansionDsl<T,C>, ReferenceExpansionSupport<T>

public class MetaModelUpdateCommandDslImpl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>,E>
extends CommandImpl<T>
implements UpdateCommandDsl<T,C>, MetaModelExpansionDslExpansionModelRead<T,C,E>

Internal base class to implement commands that change one resource in Composable Commerce.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetaModelUpdateCommandDslImpl(MetaModelUpdateCommandDslBuilder<T,C,E> builder)
protected	MetaModelUpdateCommandDslImpl(Versioned<T> versioned, List<? extends UpdateAction<T>> updateActions, JsonEndpoint<T> endpoint, Function<MetaModelUpdateCommandDslBuilder<T,C,E>,C> creationFunction, E expansionModel)

Method Summary

Modifier and Type	Method and Description
protected List<NameValuePair>	additionalHttpQueryParameters()
protected MetaModelUpdateCommandDslBuilder<T,C,E>	copyBuilder()
E	expansionModel()
List<ExpansionPath<T>>	expansionPaths()
List<? extends UpdateAction<T>>	getUpdateActions() Gets the list of updates which should be applied to the object
Versioned<T>	getVersioned()
HttpRequestIntent	httpRequestIntent() Provides an http request intent, this does not include the execution of it.
protected com.fasterxml.jackson.databind.JavaType	jacksonJavaType()
C	plusExpansionPaths(ExpansionPath<T> expansionPath) Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
C	plusExpansionPaths(Function<E,ExpansionPathContainer<T>> m) Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.
C	plusExpansionPaths(List<ExpansionPath<T>> expansionPaths) Creates a new object with the properties of the old object but adds expansionPaths to the expansion paths.
C	plusExpansionPaths(String expansionPath) Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
C	plusUpdateActions(List<? extends UpdateAction<T>> updateActions) Creates a copy of this update command with additional update actions.
protected C	withAdditionalHttpQueryParameters(List<NameValuePair> pairs)
C	withAdditionalHttpQueryParameters(NameValuePair pair)
C	withExpansionPaths(ExpansionPath<T> expansionPath) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.
C	withExpansionPaths(Function<E,ExpansionPathContainer<T>> m) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath by using meta models.
C	withExpansionPaths(List<ExpansionPath<T>> expansionPaths) Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.
C	withExpansionPaths(String expansionPath) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.
C	withUpdateActions(List<? extends UpdateAction<T>> updateActions)
C	withVersion(Long version)
C	withVersion(Versioned<T> newVersioned) Creates a copy of this update command with a different value for version.

Methods inherited from class io.sphere.sdk.commands.CommandImpl

deserialize

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, deserialize

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Constructor Detail

MetaModelUpdateCommandDslImpl

protected MetaModelUpdateCommandDslImpl(Versioned<T> versioned,
                                        List<? extends UpdateAction<T>> updateActions,
                                        JsonEndpoint<T> endpoint,
                                        Function<MetaModelUpdateCommandDslBuilder<T,C,E>,C> creationFunction,
                                        E expansionModel)

MetaModelUpdateCommandDslImpl

protected MetaModelUpdateCommandDslImpl(MetaModelUpdateCommandDslBuilder<T,C,E> builder)

Method Detail

jacksonJavaType

protected com.fasterxml.jackson.databind.JavaType jacksonJavaType()

Specified by:

jacksonJavaType in class CommandImpl<T extends ResourceView<T,T>>

httpRequestIntent

public HttpRequestIntent httpRequestIntent()

Description copied from interface: SphereRequest

Provides an http request intent, this does not include the execution of it.

Specified by:

httpRequestIntent in interface SphereRequest<T extends ResourceView<T,T>>

Returns:

http request intent

withVersion

public C withVersion(Versioned<T> newVersioned)

Description copied from interface: UpdateCommandDsl

Creates a copy of this update command with a different value for version.

Specified by:

withVersion in interface UpdateCommandDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

newVersioned - the new versioned parameter which is expected to contain the most recent version of the resource, do not change the ID

Returns:

the new update command

withVersion

public C withVersion(Long version)

Specified by:

withVersion in interface UpdateCommandDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

withUpdateActions

public C withUpdateActions(List<? extends UpdateAction<T>> updateActions)

Specified by:

withUpdateActions in interface UpdateCommandDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

plusUpdateActions

public C plusUpdateActions(List<? extends UpdateAction<T>> updateActions)

Description copied from interface: UpdateCommandDsl

Creates a copy of this update command with additional update actions.

Specified by:

plusUpdateActions in interface UpdateCommandDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

updateActions - the new update actions to append to the update command.

Returns:

the new update command

getVersioned

public Versioned<T> getVersioned()

getUpdateActions

public List<? extends UpdateAction<T>> getUpdateActions()

Description copied from interface: UpdateCommand

Gets the list of updates which should be applied to the object

Specified by:

getUpdateActions in interface UpdateCommand<T extends ResourceView<T,T>>

Returns:

update actions

copyBuilder

protected MetaModelUpdateCommandDslBuilder<T,C,E> copyBuilder()

expansionPaths

public List<ExpansionPath<T>> expansionPaths()

Specified by:

expansionPaths in interface ExpansionPathContainer<T extends ResourceView<T,T>>

Specified by:

expansionPaths in interface ReferenceExpansionSupport<T extends ResourceView<T,T>>

withExpansionPaths

public final C withExpansionPaths(List<ExpansionPath<T>> expansionPaths)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

expansionPaths - the new expansion paths

Returns:

new object

withExpansionPaths

public C withExpansionPaths(ExpansionPath<T> expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .withExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 =
        fetch.withExpansionPaths(ProductProjectionExpansionModel.of().productType());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged")
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

This method also can be used to use the same expansions as in another request:

final ProductProjectionQuery query = ProductProjectionQuery.ofCurrent().withExpansionPaths(m -> m.categories());
final ProductProjectionSearch search = ProductProjectionSearch.ofCurrent().withExpansionPaths(query);
assertThat(query.expansionPaths())
        .hasSize(1)
        .as("reuse expansion spec from other request")
        .isEqualTo(search.expansionPaths());
See the test code.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

expansionPath - the new expansion paths

Returns:

new object

withExpansionPaths

public C withExpansionPaths(Function<E,ExpansionPathContainer<T>> m)

Description copied from interface: MetaModelReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath by using meta models.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .plusExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 =
        fetch.withExpansionPaths(m -> m.productType());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged")
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

Specified by:

withExpansionPaths in interface MetaModelReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>,E>

Parameters:

m - function to use the meta model for expansions to create an expansion path

Returns:

new object

plusExpansionPaths

public C plusExpansionPaths(List<ExpansionPath<T>> expansionPaths)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but adds expansionPaths to the expansion paths.

Specified by:

plusExpansionPaths in interface ReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

expansionPaths - the new expansion paths to add to the existing ones

Returns:

new object

plusExpansionPaths

public C plusExpansionPaths(ExpansionPath<T> expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT);

assertThat(fetch.expansionPaths()).isEmpty();

final ProductProjectionByIdGet fetch2 =
        fetch.plusExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged").isEmpty();
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

Specified by:

plusExpansionPaths in interface ReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

expansionPath - the new expansion path to add to the existing ones

Returns:

new object

withExpansionPaths

public C withExpansionPaths(String expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .withExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 =
        fetch.withExpansionPaths(ProductProjectionExpansionModel.of().productType());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged")
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

This method also can be used to use the same expansions as in another request:

final ProductProjectionQuery query = ProductProjectionQuery.ofCurrent().withExpansionPaths(m -> m.categories());
final ProductProjectionSearch search = ProductProjectionSearch.ofCurrent().withExpansionPaths(query);
assertThat(query.expansionPaths())
        .hasSize(1)
        .as("reuse expansion spec from other request")
        .isEqualTo(search.expansionPaths());
See the test code.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

expansionPath - the new expansion paths

Returns:

new object

plusExpansionPaths

public C plusExpansionPaths(String expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT);

assertThat(fetch.expansionPaths()).isEmpty();

final ProductProjectionByIdGet fetch2 =
        fetch.plusExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged").isEmpty();
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

Specified by:

plusExpansionPaths in interface ReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>

Parameters:

expansionPath - the new expansion path to add to the existing ones

Returns:

new object

plusExpansionPaths

public C plusExpansionPaths(Function<E,ExpansionPathContainer<T>> m)

Description copied from interface: MetaModelReferenceExpansionDsl

Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.

An example in the product projection context:

final ProductProjectionByIdGet fetch1 = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
        .plusExpansionPaths(m -> m.categories());
assertThat(fetch1.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 = fetch1.plusExpansionPaths(m -> m.productType());
assertThat(fetch2.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType")))
        .isEqualTo(listOf(fetch1.expansionPaths(), ExpansionPath.of("productType")));

//this is equivalent to

final ExpansionPath<ProductProjection> categoryExpand = ProductProjectionExpansionModel.of().categories().expansionPaths().get(0);
final ExpansionPath<ProductProjection> productTypeExpand = ProductProjectionExpansionModel.of().productType().expansionPaths().get(0);
final ProductProjectionByIdGet fetchB = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .withExpansionPaths(asList(categoryExpand, productTypeExpand));
assertThat(fetchB.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType")));
See the test code.

Specified by:

plusExpansionPaths in interface MetaModelReferenceExpansionDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>,E>

Parameters:

m - function to use the meta model for expansions to create an expansion path

Returns:

new object

expansionModel

public E expansionModel()

Specified by:

expansionModel in interface MetaModelExpansionDslExpansionModelRead<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>,E>

additionalHttpQueryParameters

protected List<NameValuePair> additionalHttpQueryParameters()

withAdditionalHttpQueryParameters

protected C withAdditionalHttpQueryParameters(List<NameValuePair> pairs)

withAdditionalHttpQueryParameters

public C withAdditionalHttpQueryParameters(NameValuePair pair)

Specified by:

withAdditionalHttpQueryParameters in interface UpdateCommandDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>>