io.sphere.sdk.expansion.MetaModelExpansionDsl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sphere-common Show documentation

sphere-common

There is a newer version: 1.0.0-M26

package io.sphere.sdk.expansion;

import java.util.function.Function;

public interface MetaModelExpansionDsl extends ReferenceExpansionDsl {
    /**
     * 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:
     * {@include.example io.sphere.sdk.products.expansion.ProductProjectionExpansionModelTest#expandCategoriesDemo()}
     *
     * @param m function to use the meta model for expansions to create an expansion path
     * @return new object
     */
    C plusExpansionPaths(final Function> m);

    /**
     * Creates a new object with the properties of the old object but replaces all expansion paths with a single {@code expansionPath} by using meta models.
     *
     * An example in the product projection context:
     * {@include.example io.sphere.sdk.products.expansion.ProductProjectionExpansionModelTest#withExpansionPathDslDemo()}
     *
     * @param m function to use the meta model for expansions to create an expansion path
     * @return new object
     */
    C withExpansionPaths(final Function> m);
}