io.sphere.sdk.products.attributes

Class AttributeDefinitionBuilder

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.products.attributes.AttributeDefinitionBuilder

All Implemented Interfaces:

Builder<AttributeDefinition>, Supplier<AttributeDefinition>

public final class AttributeDefinitionBuilder
extends Base
implements Builder<AttributeDefinition>

Builder to create an attribute definition for product types.

For AttributeTypes use the Javadoc page of AttributeTypes.

brief example:

final AttributeDefinition isbn = AttributeDefinitionBuilder
        .of(ISBN_ATTR_NAME, en("ISBN"), StringAttributeType.of())
        .build();

final ProductTypeDraft productTypeDraft = ProductTypeDraft.of(randomKey(), BOOK_PRODUCT_TYPE_NAME, "books", asList(isbn));
final ProductType productType = client().executeBlocking(ProductTypeCreateCommand.of(productTypeDraft));
See the test code.

long example:

final LocalizedEnumValue green = LocalizedEnumValue.of("green",
        LocalizedString.of(ENGLISH, "green").plus(GERMAN, "grün"));
final LocalizedEnumValue red = LocalizedEnumValue.of("red",
        LocalizedString.of(ENGLISH, "red").plus(GERMAN, "rot"));
final AttributeDefinition color = AttributeDefinitionBuilder
        .of(COLOR_ATTR_NAME, en("color"), LocalizedEnumAttributeType.of(red, green))
        .required(true)
        .build();

final EnumValue s = EnumValue.of("S", "S");
final EnumValue m = EnumValue.of("M", "M");
final EnumValue x = EnumValue.of("X", "X");
final AttributeDefinition size = AttributeDefinitionBuilder
        .of(SIZE_ATTR_NAME, en("size"), EnumAttributeType.of(s, m, x))
        .required(true)
        .build();

final LocalizedEnumValue cold = LocalizedEnumValue.of("cold",
        LocalizedString.of(ENGLISH, "Wash at or below 30°C ").plus(GERMAN, "30°C"));
final LocalizedEnumValue hot = LocalizedEnumValue.of("hot",
        LocalizedString.of(ENGLISH, "Wash at or below 60°C ").plus(GERMAN, "60°C"));
final LocalizedEnumValue tumbleDrying = LocalizedEnumValue.of("tumbleDrying",
        LocalizedString.of(ENGLISH, "tumble drying").plus(GERMAN, "Trommeltrocknen"));
final LocalizedEnumValue noTumbleDrying = LocalizedEnumValue.of("noTumbleDrying",
        LocalizedString.of(ENGLISH, "no tumble drying").plus(GERMAN, "Nicht im Trommeltrockner trocknen"));
final SetAttributeType laundryLabelType = SetAttributeType.of(LocalizedEnumAttributeType.of(cold, hot, tumbleDrying, noTumbleDrying));
final AttributeDefinition laundrySymbols = AttributeDefinitionBuilder
        .of(LAUNDRY_SYMBOLS_ATTR_NAME, en("washing labels"), laundryLabelType)
        .build();

final AttributeDefinition matchingProducts = AttributeDefinitionBuilder
        .of(MATCHING_PRODUCTS_ATTR_NAME, en("matching products"), SetAttributeType.of(ReferenceAttributeType.ofProduct()))
        .build();

final AttributeDefinition rrp = AttributeDefinitionBuilder
        .of(RRP_ATTR_NAME, en("recommended retail price"), MoneyAttributeType.of())
        .build();

final AttributeDefinition availableSince = AttributeDefinitionBuilder
        .of(AVAILABLE_SINCE_ATTR_NAME, en("available since"), DateAttributeType.of())
        .build();


final List<AttributeDefinition> attributes = asList(color, size, laundrySymbols,
        matchingProducts, rrp, availableSince);
final ProductTypeDraft productTypeDraft = ProductTypeDraft.of(randomKey(), PRODUCT_TYPE_NAME, "a 'T' shaped cloth", attributes);
final ProductType productType = client().executeBlocking(ProductTypeCreateCommand.of(productTypeDraft));
See the test code.

Method Summary

Modifier and Type	Method and Description
AttributeDefinitionBuilder	attributeConstraint(AttributeConstraint attributeConstraint)
AttributeDefinition	build() Creates a new instance of T with the values of this builder.
AttributeConstraint	getAttributeConstraint()
AttributeType	getAttributeType()
TextInputHint	getInputHint()
LocalizedString	getInputTip()
LocalizedString	getLabel()
String	getName()
AttributeDefinitionBuilder	inputHint(TextInputHint inputHint)
AttributeDefinitionBuilder	inputTip(LocalizedString inputTip)
Boolean	isRequired()
AttributeDefinitionBuilder	isRequired(boolean isRequired)
Boolean	isSearchable()
AttributeDefinitionBuilder	isSearchable(boolean isSearchable)
AttributeDefinitionBuilder	label(LocalizedString label)
AttributeDefinitionBuilder	name(String name)
static AttributeDefinitionBuilder	of(String name, LocalizedString label, AttributeType attributeType)
AttributeDefinitionBuilder	required(boolean isRequired)
AttributeDefinitionBuilder	searchable(boolean isSearchable)

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.models.Builder

get

Method Detail

attributeConstraint

public AttributeDefinitionBuilder attributeConstraint(AttributeConstraint attributeConstraint)

inputHint

public AttributeDefinitionBuilder inputHint(TextInputHint inputHint)

label

public AttributeDefinitionBuilder label(LocalizedString label)

name

public AttributeDefinitionBuilder name(String name)

inputTip

public AttributeDefinitionBuilder inputTip(LocalizedString inputTip)

required

public AttributeDefinitionBuilder required(boolean isRequired)

isRequired

public AttributeDefinitionBuilder isRequired(boolean isRequired)

searchable

public AttributeDefinitionBuilder searchable(boolean isSearchable)

isSearchable

public AttributeDefinitionBuilder isSearchable(boolean isSearchable)

build

public AttributeDefinition build()

Description copied from interface: Builder

Creates a new instance of T with the values of this builder.

Specified by:

build in interface Builder<AttributeDefinition>

Returns:

new instance of T.

of

public static AttributeDefinitionBuilder of(String name,
                                            LocalizedString label,
                                            AttributeType attributeType)

getAttributeConstraint

public AttributeConstraint getAttributeConstraint()

getAttributeType

public AttributeType getAttributeType()

getInputHint

public TextInputHint getInputHint()

getInputTip

@Nullable
public LocalizedString getInputTip()

isRequired

public Boolean isRequired()

isSearchable

public Boolean isSearchable()

getLabel

public LocalizedString getLabel()

getName

public String getName()