Package com.commercetools.api.models.shopping_list

Class ShoppingListDraftBuilder

java.lang.Object

com.commercetools.api.models.shopping_list.ShoppingListDraftBuilder

All Implemented Interfaces:

Builder<ShoppingListDraft>

public class ShoppingListDraftBuilder
extends Object
implements Builder<ShoppingListDraft>

ShoppingListDraftBuilder Example to create an instance using the builder pattern

     ShoppingListDraft shoppingListDraft = ShoppingListDraft.builder()
             .name(nameBuilder -> nameBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ShoppingListDraftBuilder()

Method Summary

Modifier and Type	Method	Description
ShoppingListDraftBuilder	addLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraft> builder)	Line Items (containing Products) to add to the ShoppingList.
ShoppingListDraftBuilder	addTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraft> builder)	Line Items (containing text values) to add to the ShoppingList.
ShoppingListDraftBuilder	anonymousId(String anonymousId)	Identifies ShoppingLists belonging to an anonymous session.
ShoppingListDraft	build()	builds ShoppingListDraft with checking for non-null required values
ShoppingListDraft	buildUnchecked()	builds ShoppingListDraft without checking for non-null required values
ShoppingListDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields defined for the ShoppingList.
ShoppingListDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields defined for the ShoppingList.
ShoppingListDraftBuilder	customer(CustomerResourceIdentifier customer)	The Customer the ShoppingList should be associated to.
ShoppingListDraftBuilder	customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)	The Customer the ShoppingList should be associated to.
ShoppingListDraftBuilder	deleteDaysAfterLastModification(Long deleteDaysAfterLastModification)	Number of days after which the ShoppingList will be automatically deleted if it has not been modified.
ShoppingListDraftBuilder	description(LocalizedString description)	Description of the ShoppingList.
ShoppingListDraftBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the ShoppingList.
String	getAnonymousId()	Identifies ShoppingLists belonging to an anonymous session.
CustomFieldsDraft	getCustom()	Custom Fields defined for the ShoppingList.
CustomerResourceIdentifier	getCustomer()	The Customer the ShoppingList should be associated to.
Long	getDeleteDaysAfterLastModification()	Number of days after which the ShoppingList will be automatically deleted if it has not been modified.
LocalizedString	getDescription()	Description of the ShoppingList.
String	getKey()	User-defined unique identifier for the ShoppingList.
List<ShoppingListLineItemDraft>	getLineItems()	Line Items (containing Products) to add to the ShoppingList.
LocalizedString	getName()	Name of the ShoppingList.
LocalizedString	getSlug()	Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
StoreResourceIdentifier	getStore()	Assigns the new ShoppingList to the Store.
List<TextLineItemDraft>	getTextLineItems()	Line Items (containing text values) to add to the ShoppingList.
ShoppingListDraftBuilder	key(String key)	User-defined unique identifier for the ShoppingList.
ShoppingListDraftBuilder	lineItems(ShoppingListLineItemDraft... lineItems)	Line Items (containing Products) to add to the ShoppingList.
ShoppingListDraftBuilder	lineItems(List<ShoppingListLineItemDraft> lineItems)	Line Items (containing Products) to add to the ShoppingList.
ShoppingListDraftBuilder	name(LocalizedString name)	Name of the ShoppingList.
ShoppingListDraftBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the ShoppingList.
static ShoppingListDraftBuilder	of()	factory method for an instance of ShoppingListDraftBuilder
static ShoppingListDraftBuilder	of(ShoppingListDraft template)	create builder for ShoppingListDraft instance
ShoppingListDraftBuilder	plusLineItems(ShoppingListLineItemDraft... lineItems)	Line Items (containing Products) to add to the ShoppingList.
ShoppingListDraftBuilder	plusLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraftBuilder> builder)	Line Items (containing Products) to add to the ShoppingList.
ShoppingListDraftBuilder	plusTextLineItems(TextLineItemDraft... textLineItems)	Line Items (containing text values) to add to the ShoppingList.
ShoppingListDraftBuilder	plusTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraftBuilder> builder)	Line Items (containing text values) to add to the ShoppingList.
ShoppingListDraftBuilder	setLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraft> builder)	Line Items (containing Products) to add to the ShoppingList.
ShoppingListDraftBuilder	setTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraft> builder)	Line Items (containing text values) to add to the ShoppingList.
ShoppingListDraftBuilder	slug(LocalizedString slug)	Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
ShoppingListDraftBuilder	slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
ShoppingListDraftBuilder	store(StoreResourceIdentifier store)	Assigns the new ShoppingList to the Store.
ShoppingListDraftBuilder	store(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)	Assigns the new ShoppingList to the Store.
ShoppingListDraftBuilder	textLineItems(TextLineItemDraft... textLineItems)	Line Items (containing text values) to add to the ShoppingList.
ShoppingListDraftBuilder	textLineItems(List<TextLineItemDraft> textLineItems)	Line Items (containing text values) to add to the ShoppingList.
ShoppingListDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields defined for the ShoppingList.
ShoppingListDraftBuilder	withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)	The Customer the ShoppingList should be associated to.
ShoppingListDraftBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the ShoppingList.
ShoppingListDraftBuilder	withLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraftBuilder> builder)	Line Items (containing Products) to add to the ShoppingList.
ShoppingListDraftBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the ShoppingList.
ShoppingListDraftBuilder	withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)	Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
ShoppingListDraftBuilder	withStore(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)	Assigns the new ShoppingList to the Store.
ShoppingListDraftBuilder	withTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraftBuilder> builder)	Line Items (containing text values) to add to the ShoppingList.

Methods inherited from class java.lang.Object

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

Constructor Details

ShoppingListDraftBuilder

public ShoppingListDraftBuilder()

Method Details

name

public ShoppingListDraftBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Name of the ShoppingList.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

public ShoppingListDraftBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

Name of the ShoppingList.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public ShoppingListDraftBuilder name(LocalizedString name)

Name of the ShoppingList.

Parameters:

name - value to be set

Returns:

Builder

slug

public ShoppingListDraftBuilder slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Human-readable identifiers usually used as deep-link URL to the related ShoppingList. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. The slug must match the pattern [a-zA-Z0-9_-]{2,256}.

Parameters:

builder - function to build the slug value

Returns:

Builder

withSlug

public ShoppingListDraftBuilder withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)

Human-readable identifiers usually used as deep-link URL to the related ShoppingList. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. The slug must match the pattern [a-zA-Z0-9_-]{2,256}.

Parameters:

builder - function to build the slug value

Returns:

Builder

slug

public ShoppingListDraftBuilder slug(@Nullable
 LocalizedString slug)

Human-readable identifiers usually used as deep-link URL to the related ShoppingList. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. The slug must match the pattern [a-zA-Z0-9_-]{2,256}.

Parameters:

slug - value to be set

Returns:

Builder

customer

public ShoppingListDraftBuilder customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)

The Customer the ShoppingList should be associated to.

Parameters:

builder - function to build the customer value

Returns:

Builder

withCustomer

public ShoppingListDraftBuilder withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)

The Customer the ShoppingList should be associated to.

Parameters:

builder - function to build the customer value

Returns:

Builder

customer

public ShoppingListDraftBuilder customer(@Nullable
 CustomerResourceIdentifier customer)

The Customer the ShoppingList should be associated to.

Parameters:

customer - value to be set

Returns:

Builder

key

public ShoppingListDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the ShoppingList.

Parameters:

key - value to be set

Returns:

Builder

description

public ShoppingListDraftBuilder description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Description of the ShoppingList.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

public ShoppingListDraftBuilder withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)

Description of the ShoppingList.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public ShoppingListDraftBuilder description(@Nullable
 LocalizedString description)

Description of the ShoppingList.

Parameters:

description - value to be set

Returns:

Builder

anonymousId

public ShoppingListDraftBuilder anonymousId(@Nullable
 String anonymousId)

Identifies ShoppingLists belonging to an anonymous session.

Parameters:

anonymousId - value to be set

Returns:

Builder

deleteDaysAfterLastModification

public ShoppingListDraftBuilder deleteDaysAfterLastModification(@Nullable
 Long deleteDaysAfterLastModification)

Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the default value configured in the Project is used.

Parameters:

deleteDaysAfterLastModification - value to be set

Returns:

Builder

lineItems

public ShoppingListDraftBuilder lineItems(@Nullable
 ShoppingListLineItemDraft... lineItems)

Line Items (containing Products) to add to the ShoppingList.

Parameters:

lineItems - value to be set

Returns:

Builder

lineItems

public ShoppingListDraftBuilder lineItems(@Nullable
 List<ShoppingListLineItemDraft> lineItems)

Line Items (containing Products) to add to the ShoppingList.

Parameters:

lineItems - value to be set

Returns:

Builder

plusLineItems

public ShoppingListDraftBuilder plusLineItems(@Nullable
 ShoppingListLineItemDraft... lineItems)

Line Items (containing Products) to add to the ShoppingList.

Parameters:

lineItems - value to be set

Returns:

Builder

plusLineItems

public ShoppingListDraftBuilder plusLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraftBuilder> builder)

Line Items (containing Products) to add to the ShoppingList.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

withLineItems

public ShoppingListDraftBuilder withLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraftBuilder> builder)

Line Items (containing Products) to add to the ShoppingList.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

addLineItems

public ShoppingListDraftBuilder addLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraft> builder)

Line Items (containing Products) to add to the ShoppingList.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

setLineItems

public ShoppingListDraftBuilder setLineItems(Function<ShoppingListLineItemDraftBuilder,ShoppingListLineItemDraft> builder)

Line Items (containing Products) to add to the ShoppingList.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

textLineItems

public ShoppingListDraftBuilder textLineItems(@Nullable
 TextLineItemDraft... textLineItems)

Line Items (containing text values) to add to the ShoppingList.

Parameters:

textLineItems - value to be set

Returns:

Builder

textLineItems

public ShoppingListDraftBuilder textLineItems(@Nullable
 List<TextLineItemDraft> textLineItems)

Line Items (containing text values) to add to the ShoppingList.

Parameters:

textLineItems - value to be set

Returns:

Builder

plusTextLineItems

public ShoppingListDraftBuilder plusTextLineItems(@Nullable
 TextLineItemDraft... textLineItems)

Line Items (containing text values) to add to the ShoppingList.

Parameters:

textLineItems - value to be set

Returns:

Builder

plusTextLineItems

public ShoppingListDraftBuilder plusTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraftBuilder> builder)

Line Items (containing text values) to add to the ShoppingList.

Parameters:

builder - function to build the textLineItems value

Returns:

Builder

withTextLineItems

public ShoppingListDraftBuilder withTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraftBuilder> builder)

Line Items (containing text values) to add to the ShoppingList.

Parameters:

builder - function to build the textLineItems value

Returns:

Builder

addTextLineItems

public ShoppingListDraftBuilder addTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraft> builder)

Line Items (containing text values) to add to the ShoppingList.

Parameters:

builder - function to build the textLineItems value

Returns:

Builder

setTextLineItems

public ShoppingListDraftBuilder setTextLineItems(Function<TextLineItemDraftBuilder,TextLineItemDraft> builder)

Line Items (containing text values) to add to the ShoppingList.

Parameters:

builder - function to build the textLineItems value

Returns:

Builder

store

public ShoppingListDraftBuilder store(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)

Assigns the new ShoppingList to the Store.

Parameters:

builder - function to build the store value

Returns:

Builder

withStore

public ShoppingListDraftBuilder withStore(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)

Assigns the new ShoppingList to the Store.

Parameters:

builder - function to build the store value

Returns:

Builder

store

public ShoppingListDraftBuilder store(@Nullable
 StoreResourceIdentifier store)

Assigns the new ShoppingList to the Store.

Parameters:

store - value to be set

Returns:

Builder

custom

public ShoppingListDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields defined for the ShoppingList.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public ShoppingListDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields defined for the ShoppingList.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public ShoppingListDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields defined for the ShoppingList.

Parameters:

custom - value to be set

Returns:

Builder

getName

public LocalizedString getName()

Name of the ShoppingList.

Returns:

name

getSlug

@Nullable
public LocalizedString getSlug()

Human-readable identifiers usually used as deep-link URL to the related ShoppingList. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. The slug must match the pattern [a-zA-Z0-9_-]{2,256}.

Returns:

slug

getCustomer

@Nullable
public CustomerResourceIdentifier getCustomer()

The Customer the ShoppingList should be associated to.

Returns:

customer

getKey

@Nullable
public String getKey()

User-defined unique identifier for the ShoppingList.

Returns:

key

getDescription

@Nullable
public LocalizedString getDescription()

Description of the ShoppingList.

Returns:

description

getAnonymousId

@Nullable
public String getAnonymousId()

Identifies ShoppingLists belonging to an anonymous session.

Returns:

anonymousId

getDeleteDaysAfterLastModification

@Nullable
public Long getDeleteDaysAfterLastModification()

Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the default value configured in the Project is used.

Returns:

deleteDaysAfterLastModification

getLineItems

@Nullable
public List<ShoppingListLineItemDraft> getLineItems()

Line Items (containing Products) to add to the ShoppingList.

Returns:

lineItems

getTextLineItems

@Nullable
public List<TextLineItemDraft> getTextLineItems()

Line Items (containing text values) to add to the ShoppingList.

Returns:

textLineItems

getStore

@Nullable
public StoreResourceIdentifier getStore()

Assigns the new ShoppingList to the Store.

Returns:

store

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields defined for the ShoppingList.

Returns:

custom

build

public ShoppingListDraft build()

builds ShoppingListDraft with checking for non-null required values

Specified by:

build in interface Builder<ShoppingListDraft>

Returns:

ShoppingListDraft

buildUnchecked

public ShoppingListDraft buildUnchecked()

builds ShoppingListDraft without checking for non-null required values

Returns:

ShoppingListDraft

of

public static ShoppingListDraftBuilder of()

factory method for an instance of ShoppingListDraftBuilder

Returns:

builder

of

public static ShoppingListDraftBuilder of(ShoppingListDraft template)

create builder for ShoppingListDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder