Interface CategoryOrderHints
public interface CategoryOrderHints
JSON object where the key is a Category id
and the value is an order hint. Allows controlling the order of Products and how they appear in Categories. Products with no order hint have an order score below 0
. Order hints are non-unique. If a subset of Products have the same value for order hint in a specific category, the behavior is undetermined.
Example to create an instance using the builder pattern
CategoryOrderHints categoryOrderHints = CategoryOrderHints.builder()
./[0-9].[0-9]*[1-9]/("{/[0-9].[0-9]*[1-9]/}")
.build()
-
Method Summary
Modifier and TypeMethodDescriptionstatic CategoryOrderHintsBuilder
builder()
builder factory method for CategoryOrderHintsstatic CategoryOrderHintsBuilder
builder
(CategoryOrderHints template) create builder for CategoryOrderHints instancestatic CategoryOrderHints
deepCopy
(CategoryOrderHints template) factory method to create a deep copy of CategoryOrderHintsstatic CategoryOrderHints
of()
factory methodstatic CategoryOrderHints
of
(CategoryOrderHints template) factory method to create a shallow copy CategoryOrderHintsvoid
A string representing a number between 0 and 1 that must start with0.
and cannot end with0
.static com.fasterxml.jackson.core.type.TypeReference<CategoryOrderHints>
gives a TypeReference for usage with Jackson DataBindvalues()
A string representing a number between 0 and 1 that must start with0.
and cannot end with0
.default <T> T
withCategoryOrderHints
(Function<CategoryOrderHints, T> helper) accessor map function
-
Method Details
-
values
A string representing a number between 0 and 1 that must start with
0.
and cannot end with0
.- Returns:
- map of the pattern property values
-
setValue
A string representing a number between 0 and 1 that must start with
0.
and cannot end with0
.- Parameters:
key
- property namevalue
- property value
-
of
factory method- Returns:
- instance of CategoryOrderHints
-
of
factory method to create a shallow copy CategoryOrderHints- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
factory method to create a deep copy of CategoryOrderHints- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for CategoryOrderHints- Returns:
- builder
-
builder
create builder for CategoryOrderHints instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withCategoryOrderHints
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-