Package com.commercetools.importapi.models.productvariants

Interface Attribute

All Known Subinterfaces:

BooleanAttribute, BooleanSetAttribute, DateAttribute, DateSetAttribute, DateTimeAttribute, DateTimeSetAttribute, EnumAttribute, EnumSetAttribute, LocalizableEnumAttribute, LocalizableEnumSetAttribute, LocalizableTextAttribute, LocalizableTextSetAttribute, MoneyAttribute, MoneySetAttribute, NumberAttribute, NumberSetAttribute, ReferenceAttribute, ReferenceSetAttribute, TextAttribute, TextSetAttribute, TimeAttribute, TimeSetAttribute

public interface Attribute

Represents the value of an Attribute of a Product Variant.

Example to create a subtype instance using the builder pattern

     Attribute attribute = Attribute.booleanBuilder()
             value(true)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static BooleanAttributeBuilder	booleanBuilder()	builder for boolean subtype
static BooleanSetAttributeBuilder	booleanSetBuilder()	builder for booleanSet subtype
Attribute	copyDeep()
static DateAttributeBuilder	dateBuilder()	builder for date subtype
static DateSetAttributeBuilder	dateSetBuilder()	builder for dateSet subtype
static DateTimeAttributeBuilder	datetimeBuilder()	builder for datetime subtype
static DateTimeSetAttributeBuilder	datetimeSetBuilder()	builder for datetimeSet subtype
static Attribute	deepCopy(Attribute template)	factory method to create a deep copy of Attribute
static EnumAttributeBuilder	enumBuilder()	builder for enum subtype
static EnumSetAttributeBuilder	enumSetBuilder()	builder for enumSet subtype
String	getName()	Required if used for ProductVariantImport.
@NotNull String	getType()	Must match type of an AttributeDefinition of the Product Type.
static LocalizableEnumAttributeBuilder	lenumBuilder()	builder for lenum subtype
static LocalizableEnumSetAttributeBuilder	lenumSetBuilder()	builder for lenumSet subtype
static LocalizableTextAttributeBuilder	ltextBuilder()	builder for ltext subtype
static LocalizableTextSetAttributeBuilder	ltextSetBuilder()	builder for ltextSet subtype
static MoneyAttributeBuilder	moneyBuilder()	builder for money subtype
static MoneySetAttributeBuilder	moneySetBuilder()	builder for moneySet subtype
static NumberAttributeBuilder	numberBuilder()	builder for number subtype
static NumberSetAttributeBuilder	numberSetBuilder()	builder for numberSet subtype
static ReferenceAttributeBuilder	referenceBuilder()	builder for reference subtype
static ReferenceSetAttributeBuilder	referenceSetBuilder()	builder for referenceSet subtype
void	setName(String name)	Required if used for ProductVariantImport.
static TextAttributeBuilder	textBuilder()	builder for text subtype
static TextSetAttributeBuilder	textSetBuilder()	builder for textSet subtype
static TimeAttributeBuilder	timeBuilder()	builder for time subtype
static TimeSetAttributeBuilder	timeSetBuilder()	builder for timeSet subtype
static com.fasterxml.jackson.core.type.TypeReference<Attribute>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAttribute(Function<Attribute,T> helper)	accessor map function

Method Details

getName

String getName()

Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch.

Must match name of an AttributeDefinition of the Product Type.

Returns:

name

getType

@NotNull
@NotNull String getType()

Must match type of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.

Returns:

type

setName

void setName(String name)

Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch.

Must match name of an AttributeDefinition of the Product Type.

Parameters:

name - value to be set

copyDeep

Attribute copyDeep()

deepCopy

@Nullable
static Attribute deepCopy(@Nullable
 Attribute template)

factory method to create a deep copy of Attribute

Parameters:

template - instance to be copied

Returns:

copy instance

booleanBuilder

static BooleanAttributeBuilder booleanBuilder()

builder for boolean subtype

Returns:

builder

booleanSetBuilder

static BooleanSetAttributeBuilder booleanSetBuilder()

builder for booleanSet subtype

Returns:

builder

dateBuilder

static DateAttributeBuilder dateBuilder()

builder for date subtype

Returns:

builder

dateSetBuilder

static DateSetAttributeBuilder dateSetBuilder()

builder for dateSet subtype

Returns:

builder

datetimeBuilder

static DateTimeAttributeBuilder datetimeBuilder()

builder for datetime subtype

Returns:

builder

datetimeSetBuilder

static DateTimeSetAttributeBuilder datetimeSetBuilder()

builder for datetimeSet subtype

Returns:

builder

enumBuilder

static EnumAttributeBuilder enumBuilder()

builder for enum subtype

Returns:

builder

enumSetBuilder

static EnumSetAttributeBuilder enumSetBuilder()

builder for enumSet subtype

Returns:

builder

lenumBuilder

static LocalizableEnumAttributeBuilder lenumBuilder()

builder for lenum subtype

Returns:

builder

lenumSetBuilder

static LocalizableEnumSetAttributeBuilder lenumSetBuilder()

builder for lenumSet subtype

Returns:

builder

ltextBuilder

static LocalizableTextAttributeBuilder ltextBuilder()

builder for ltext subtype

Returns:

builder

ltextSetBuilder

static LocalizableTextSetAttributeBuilder ltextSetBuilder()

builder for ltextSet subtype

Returns:

builder

moneyBuilder

static MoneyAttributeBuilder moneyBuilder()

builder for money subtype

Returns:

builder

moneySetBuilder

static MoneySetAttributeBuilder moneySetBuilder()

builder for moneySet subtype

Returns:

builder

numberBuilder

static NumberAttributeBuilder numberBuilder()

builder for number subtype

Returns:

builder

numberSetBuilder

static NumberSetAttributeBuilder numberSetBuilder()

builder for numberSet subtype

Returns:

builder

referenceBuilder

static ReferenceAttributeBuilder referenceBuilder()

builder for reference subtype

Returns:

builder

referenceSetBuilder

static ReferenceSetAttributeBuilder referenceSetBuilder()

builder for referenceSet subtype

Returns:

builder

textBuilder

static TextAttributeBuilder textBuilder()

builder for text subtype

Returns:

builder

textSetBuilder

static TextSetAttributeBuilder textSetBuilder()

builder for textSet subtype

Returns:

builder

timeBuilder

static TimeAttributeBuilder timeBuilder()

builder for time subtype

Returns:

builder

timeSetBuilder

static TimeSetAttributeBuilder timeSetBuilder()

builder for timeSet subtype

Returns:

builder

withAttribute

default <T> T withAttribute(Function<Attribute,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Attribute> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference