Package com.commercetools.api.models.variant

Class VariantSetAttributeActionBuilder

java.lang.Object

com.commercetools.api.models.variant.VariantSetAttributeActionBuilder

All Implemented Interfaces:

Builder<VariantSetAttributeAction>

public class VariantSetAttributeActionBuilder
extends Object
implements Builder<VariantSetAttributeAction>

VariantSetAttributeActionBuilder Example to create an instance using the builder pattern

     VariantSetAttributeAction variantSetAttributeAction = VariantSetAttributeAction.builder()
             .name("{name}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
VariantSetAttributeActionBuilder()

Method Summary

Modifier and Type	Method	Description
VariantSetAttributeAction	build()	builds VariantSetAttributeAction with checking for non-null required values
VariantSetAttributeAction	buildUnchecked()	builds VariantSetAttributeAction without checking for non-null required values
String	getName()	Name of the Attribute to set.
Boolean	getStaged()	If true, only the staged Attribute is set.
Object	getValue()	Value to set for the Attribute.
VariantSetAttributeActionBuilder	name(String name)	Name of the Attribute to set.
static VariantSetAttributeActionBuilder	of()	factory method for an instance of VariantSetAttributeActionBuilder
static VariantSetAttributeActionBuilder	of(VariantSetAttributeAction template)	create builder for VariantSetAttributeAction instance
VariantSetAttributeActionBuilder	staged(Boolean staged)	If true, only the staged Attribute is set.
VariantSetAttributeActionBuilder	value(Object value)	Value to set for the Attribute.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VariantSetAttributeActionBuilder

public VariantSetAttributeActionBuilder()

Method Details

name

public VariantSetAttributeActionBuilder name(String name)

Name of the Attribute to set.

Parameters:

name - value to be set

Returns:

Builder

value

public VariantSetAttributeActionBuilder value(@Nullable
 Object value)

Value to set for the Attribute. If empty, any existing value will be removed.

The AttributeType determines the format of the Attribute value to be provided:

• For Enum Type and Localized Enum Type, use the key of the Plain Enum Value or Localized Enum Value object or the complete object as value.
• For Localizable Text Type, use the LocalizedString object as value.
• For Money Type Attributes, use the Money object as value.
• For Set Type Attributes, use the entire set object as value.
• For Nested Type Attributes, use the list of values of all Attributes of the nested Variant as value.
• For Reference Type Attributes, use the Reference object as value.

Parameters:

value - value to be set

Returns:

Builder

staged

public VariantSetAttributeActionBuilder staged(@Nullable
 Boolean staged)

If true, only the staged Attribute is set. If false, both the current and staged Attributes are set.

Parameters:

staged - value to be set

Returns:

Builder

getName

public String getName()

Name of the Attribute to set.

Returns:

name

getValue

@Nullable
public Object getValue()

Value to set for the Attribute. If empty, any existing value will be removed.

The AttributeType determines the format of the Attribute value to be provided:

• For Enum Type and Localized Enum Type, use the key of the Plain Enum Value or Localized Enum Value object or the complete object as value.
• For Localizable Text Type, use the LocalizedString object as value.
• For Money Type Attributes, use the Money object as value.
• For Set Type Attributes, use the entire set object as value.
• For Nested Type Attributes, use the list of values of all Attributes of the nested Variant as value.
• For Reference Type Attributes, use the Reference object as value.

Returns:

value

getStaged

@Nullable
public Boolean getStaged()

If true, only the staged Attribute is set. If false, both the current and staged Attributes are set.

Returns:

staged

build

public VariantSetAttributeAction build()

builds VariantSetAttributeAction with checking for non-null required values

Specified by:

build in interface Builder<VariantSetAttributeAction>

Returns:

VariantSetAttributeAction

buildUnchecked

public VariantSetAttributeAction buildUnchecked()

builds VariantSetAttributeAction without checking for non-null required values

Returns:

VariantSetAttributeAction

of

public static VariantSetAttributeActionBuilder of()

factory method for an instance of VariantSetAttributeActionBuilder

Returns:

builder

of

public static VariantSetAttributeActionBuilder of(VariantSetAttributeAction template)

create builder for VariantSetAttributeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder