public interface ExtensionByKeyGet extends MetaModelGetDsl<Extension,Extension,ExtensionByKeyGet,ExtensionExpansionModel<Extension>>
| Modifier and Type | Method and Description |
|---|---|
List<ExpansionPath<Extension>> |
expansionPaths() |
static ExtensionByKeyGet |
of(String key) |
ExtensionByKeyGet |
plusExpansionPaths(ExpansionPath<Extension> expansionPath)
Creates a new object with the properties of the old object but adds
expansionPath to the expansion paths. |
ExtensionByKeyGet |
withExpansionPaths(ExpansionPath<Extension> expansionPath)
Creates a new object with the properties of the old object but replaces all expansion paths with a single
expansionPath. |
ExtensionByKeyGet |
withExpansionPaths(List<ExpansionPath<Extension>> expansionPaths)
Creates a new object with the properties of the old object but replaces all expansion paths with
expansionPaths. |
deserializecanDeserialize, httpRequestIntentplusExpansionPaths, withExpansionPathsplusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPathsstatic ExtensionByKeyGet of(String key)
List<ExpansionPath<Extension>> expansionPaths()
expansionPaths in interface ExpansionPathContainer<Extension>expansionPaths in interface ReferenceExpansionSupport<Extension>ExtensionByKeyGet plusExpansionPaths(ExpansionPath<Extension> expansionPath)
ReferenceExpansionDslexpansionPath 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.
plusExpansionPaths in interface ReferenceExpansionDsl<Extension,ExtensionByKeyGet>expansionPath - the new expansion path to add to the existing onesExtensionByKeyGet withExpansionPaths(ExpansionPath<Extension> expansionPath)
ReferenceExpansionDslexpansionPath.
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.
withExpansionPaths in interface ReferenceExpansionDsl<Extension,ExtensionByKeyGet>expansionPath - the new expansion pathsExtensionByKeyGet withExpansionPaths(List<ExpansionPath<Extension>> expansionPaths)
ReferenceExpansionDslexpansionPaths.withExpansionPaths in interface ReferenceExpansionDsl<Extension,ExtensionByKeyGet>expansionPaths - the new expansion paths