Package com.commercetools.api.models.product

Class ProductDataBuilder

java.lang.Object

com.commercetools.api.models.product.ProductDataBuilder

All Implemented Interfaces:

Builder<ProductData>

public class ProductDataBuilder
extends Object
implements Builder<ProductData>

ProductDataBuilder Example to create an instance using the builder pattern

     ProductData productData = ProductData.builder()
             .name(nameBuilder -> nameBuilder)
             .plusCategories(categoriesBuilder -> categoriesBuilder)
             .slug(slugBuilder -> slugBuilder)
             .masterVariant(masterVariantBuilder -> masterVariantBuilder)
             .plusVariants(variantsBuilder -> variantsBuilder)
             .searchKeywords(searchKeywordsBuilder -> searchKeywordsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductDataBuilder()

Method Summary

Modifier and Type	Method	Description
ProductDataBuilder	addCategories(Function<CategoryReferenceBuilder,CategoryReference> builder)	Categories assigned to the Product.
ProductDataBuilder	addVariants(Function<ProductVariantBuilder,ProductVariant> builder)	Additional Product Variants.
ProductData	build()	builds ProductData with checking for non-null required values
ProductData	buildUnchecked()	builds ProductData without checking for non-null required values
ProductDataBuilder	categories(CategoryReference... categories)	Categories assigned to the Product.
ProductDataBuilder	categories(List<CategoryReference> categories)	Categories assigned to the Product.
ProductDataBuilder	categoryOrderHints(CategoryOrderHints categoryOrderHints)	Numerical values to allow ordering of Products within a specified Category.
ProductDataBuilder	categoryOrderHints(Function<CategoryOrderHintsBuilder,CategoryOrderHintsBuilder> builder)	Numerical values to allow ordering of Products within a specified Category.
ProductDataBuilder	description(LocalizedString description)	Description of the Product.
ProductDataBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the Product.
List<CategoryReference>	getCategories()	Categories assigned to the Product.
CategoryOrderHints	getCategoryOrderHints()	Numerical values to allow ordering of Products within a specified Category.
LocalizedString	getDescription()	Description of the Product.
ProductVariant	getMasterVariant()	The Master Variant of the Product.
LocalizedString	getMetaDescription()	Description of the Product displayed in search results below the meta title.
LocalizedString	getMetaKeywords()	Keywords that give additional information about the Product to search engines.
LocalizedString	getMetaTitle()	Title of the Product displayed in search results.
LocalizedString	getName()	Name of the Product.
SearchKeywords	getSearchKeywords()	Used by Product Suggestions, but is also considered for a full text search.
LocalizedString	getSlug()	User-defined identifier used in a deep-link URL for the Product.
List<ProductVariant>	getVariants()	Additional Product Variants.
ProductDataBuilder	masterVariant(ProductVariant masterVariant)	The Master Variant of the Product.
ProductDataBuilder	masterVariant(Function<ProductVariantBuilder,ProductVariantBuilder> builder)	The Master Variant of the Product.
ProductDataBuilder	metaDescription(LocalizedString metaDescription)	Description of the Product displayed in search results below the meta title.
ProductDataBuilder	metaDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the Product displayed in search results below the meta title.
ProductDataBuilder	metaKeywords(LocalizedString metaKeywords)	Keywords that give additional information about the Product to search engines.
ProductDataBuilder	metaKeywords(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Keywords that give additional information about the Product to search engines.
ProductDataBuilder	metaTitle(LocalizedString metaTitle)	Title of the Product displayed in search results.
ProductDataBuilder	metaTitle(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Title of the Product displayed in search results.
ProductDataBuilder	name(LocalizedString name)	Name of the Product.
ProductDataBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Product.
static ProductDataBuilder	of()	factory method for an instance of ProductDataBuilder
static ProductDataBuilder	of(ProductData template)	create builder for ProductData instance
ProductDataBuilder	plusCategories(CategoryReference... categories)	Categories assigned to the Product.
ProductDataBuilder	plusCategories(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)	Categories assigned to the Product.
ProductDataBuilder	plusVariants(ProductVariant... variants)	Additional Product Variants.
ProductDataBuilder	plusVariants(Function<ProductVariantBuilder,ProductVariantBuilder> builder)	Additional Product Variants.
ProductDataBuilder	searchKeywords(SearchKeywords searchKeywords)	Used by Product Suggestions, but is also considered for a full text search.
ProductDataBuilder	searchKeywords(Function<SearchKeywordsBuilder,SearchKeywordsBuilder> builder)	Used by Product Suggestions, but is also considered for a full text search.
ProductDataBuilder	setCategories(Function<CategoryReferenceBuilder,CategoryReference> builder)	Categories assigned to the Product.
ProductDataBuilder	setVariants(Function<ProductVariantBuilder,ProductVariant> builder)	Additional Product Variants.
ProductDataBuilder	slug(LocalizedString slug)	User-defined identifier used in a deep-link URL for the Product.
ProductDataBuilder	slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	User-defined identifier used in a deep-link URL for the Product.
ProductDataBuilder	variants(ProductVariant... variants)	Additional Product Variants.
ProductDataBuilder	variants(List<ProductVariant> variants)	Additional Product Variants.
ProductDataBuilder	withCategories(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)	Categories assigned to the Product.
ProductDataBuilder	withCategoryOrderHints(Function<CategoryOrderHintsBuilder,CategoryOrderHints> builder)	Numerical values to allow ordering of Products within a specified Category.
ProductDataBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the Product.
ProductDataBuilder	withMasterVariant(Function<ProductVariantBuilder,ProductVariant> builder)	The Master Variant of the Product.
ProductDataBuilder	withMetaDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the Product displayed in search results below the meta title.
ProductDataBuilder	withMetaKeywords(Function<LocalizedStringBuilder,LocalizedString> builder)	Keywords that give additional information about the Product to search engines.
ProductDataBuilder	withMetaTitle(Function<LocalizedStringBuilder,LocalizedString> builder)	Title of the Product displayed in search results.
ProductDataBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Product.
ProductDataBuilder	withSearchKeywords(Function<SearchKeywordsBuilder,SearchKeywords> builder)	Used by Product Suggestions, but is also considered for a full text search.
ProductDataBuilder	withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)	User-defined identifier used in a deep-link URL for the Product.
ProductDataBuilder	withVariants(Function<ProductVariantBuilder,ProductVariantBuilder> builder)	Additional Product Variants.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductDataBuilder

public ProductDataBuilder()

Method Details

name

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

Name of the Product.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the Product.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public ProductDataBuilder name(LocalizedString name)

Name of the Product.

Parameters:

name - value to be set

Returns:

Builder

categories

public ProductDataBuilder categories(CategoryReference... categories)

Categories assigned to the Product.

Parameters:

categories - value to be set

Returns:

Builder

categories

public ProductDataBuilder categories(List<CategoryReference> categories)

Categories assigned to the Product.

Parameters:

categories - value to be set

Returns:

Builder

plusCategories

public ProductDataBuilder plusCategories(CategoryReference... categories)

Categories assigned to the Product.

Parameters:

categories - value to be set

Returns:

Builder

plusCategories

public ProductDataBuilder plusCategories(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)

Categories assigned to the Product.

Parameters:

builder - function to build the categories value

Returns:

Builder

withCategories

public ProductDataBuilder withCategories(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)

Categories assigned to the Product.

Parameters:

builder - function to build the categories value

Returns:

Builder

addCategories

public ProductDataBuilder addCategories(Function<CategoryReferenceBuilder,CategoryReference> builder)

Categories assigned to the Product.

Parameters:

builder - function to build the categories value

Returns:

Builder

setCategories

public ProductDataBuilder setCategories(Function<CategoryReferenceBuilder,CategoryReference> builder)

Categories assigned to the Product.

Parameters:

builder - function to build the categories value

Returns:

Builder

categoryOrderHints

public ProductDataBuilder categoryOrderHints(Function<CategoryOrderHintsBuilder,CategoryOrderHintsBuilder> builder)

Numerical values to allow ordering of Products within a specified Category.

Parameters:

builder - function to build the categoryOrderHints value

Returns:

Builder

withCategoryOrderHints

public ProductDataBuilder withCategoryOrderHints(Function<CategoryOrderHintsBuilder,CategoryOrderHints> builder)

Numerical values to allow ordering of Products within a specified Category.

Parameters:

builder - function to build the categoryOrderHints value

Returns:

Builder

categoryOrderHints

public ProductDataBuilder categoryOrderHints(@Nullable
 CategoryOrderHints categoryOrderHints)

Numerical values to allow ordering of Products within a specified Category.

Parameters:

categoryOrderHints - value to be set

Returns:

Builder

description

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

Description of the Product.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

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

Description of the Product.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public ProductDataBuilder description(@Nullable
 LocalizedString description)

Description of the Product.

Parameters:

description - value to be set

Returns:

Builder

slug

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

User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_\\-]{2,256}.

Parameters:

builder - function to build the slug value

Returns:

Builder

withSlug

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

User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_\\-]{2,256}.

Parameters:

builder - function to build the slug value

Returns:

Builder

slug

public ProductDataBuilder slug(LocalizedString slug)

User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_\\-]{2,256}.

Parameters:

slug - value to be set

Returns:

Builder

metaTitle

public ProductDataBuilder metaTitle(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Title of the Product displayed in search results.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

withMetaTitle

public ProductDataBuilder withMetaTitle(Function<LocalizedStringBuilder,LocalizedString> builder)

Title of the Product displayed in search results.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

metaTitle

public ProductDataBuilder metaTitle(@Nullable
 LocalizedString metaTitle)

Title of the Product displayed in search results.

Parameters:

metaTitle - value to be set

Returns:

Builder

metaDescription

public ProductDataBuilder metaDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Description of the Product displayed in search results below the meta title.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

withMetaDescription

public ProductDataBuilder withMetaDescription(Function<LocalizedStringBuilder,LocalizedString> builder)

Description of the Product displayed in search results below the meta title.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

metaDescription

public ProductDataBuilder metaDescription(@Nullable
 LocalizedString metaDescription)

Description of the Product displayed in search results below the meta title.

Parameters:

metaDescription - value to be set

Returns:

Builder

metaKeywords

public ProductDataBuilder metaKeywords(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Keywords that give additional information about the Product to search engines.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

withMetaKeywords

public ProductDataBuilder withMetaKeywords(Function<LocalizedStringBuilder,LocalizedString> builder)

Keywords that give additional information about the Product to search engines.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

metaKeywords

public ProductDataBuilder metaKeywords(@Nullable
 LocalizedString metaKeywords)

Keywords that give additional information about the Product to search engines.

Parameters:

metaKeywords - value to be set

Returns:

Builder

masterVariant

public ProductDataBuilder masterVariant(Function<ProductVariantBuilder,ProductVariantBuilder> builder)

The Master Variant of the Product.

Parameters:

builder - function to build the masterVariant value

Returns:

Builder

withMasterVariant

public ProductDataBuilder withMasterVariant(Function<ProductVariantBuilder,ProductVariant> builder)

The Master Variant of the Product.

Parameters:

builder - function to build the masterVariant value

Returns:

Builder

masterVariant

public ProductDataBuilder masterVariant(ProductVariant masterVariant)

The Master Variant of the Product.

Parameters:

masterVariant - value to be set

Returns:

Builder

variants

public ProductDataBuilder variants(ProductVariant... variants)

Additional Product Variants.

Parameters:

variants - value to be set

Returns:

Builder

variants

public ProductDataBuilder variants(List<ProductVariant> variants)

Additional Product Variants.

Parameters:

variants - value to be set

Returns:

Builder

plusVariants

public ProductDataBuilder plusVariants(ProductVariant... variants)

Additional Product Variants.

Parameters:

variants - value to be set

Returns:

Builder

plusVariants

public ProductDataBuilder plusVariants(Function<ProductVariantBuilder,ProductVariantBuilder> builder)

Additional Product Variants.

Parameters:

builder - function to build the variants value

Returns:

Builder

withVariants

public ProductDataBuilder withVariants(Function<ProductVariantBuilder,ProductVariantBuilder> builder)

Additional Product Variants.

Parameters:

builder - function to build the variants value

Returns:

Builder

addVariants

public ProductDataBuilder addVariants(Function<ProductVariantBuilder,ProductVariant> builder)

Additional Product Variants.

Parameters:

builder - function to build the variants value

Returns:

Builder

setVariants

public ProductDataBuilder setVariants(Function<ProductVariantBuilder,ProductVariant> builder)

Additional Product Variants.

Parameters:

builder - function to build the variants value

Returns:

Builder

searchKeywords

public ProductDataBuilder searchKeywords(Function<SearchKeywordsBuilder,SearchKeywordsBuilder> builder)

Used by Product Suggestions, but is also considered for a full text search.

Parameters:

builder - function to build the searchKeywords value

Returns:

Builder

withSearchKeywords

public ProductDataBuilder withSearchKeywords(Function<SearchKeywordsBuilder,SearchKeywords> builder)

Used by Product Suggestions, but is also considered for a full text search.

Parameters:

builder - function to build the searchKeywords value

Returns:

Builder

searchKeywords

public ProductDataBuilder searchKeywords(SearchKeywords searchKeywords)

Used by Product Suggestions, but is also considered for a full text search.

Parameters:

searchKeywords - value to be set

Returns:

Builder

getName

public LocalizedString getName()

Name of the Product.

Returns:

name

getCategories

public List<CategoryReference> getCategories()

Categories assigned to the Product.

Returns:

categories

getCategoryOrderHints

@Nullable
public CategoryOrderHints getCategoryOrderHints()

Numerical values to allow ordering of Products within a specified Category.

Returns:

categoryOrderHints

getDescription

@Nullable
public LocalizedString getDescription()

Description of the Product.

Returns:

description

getSlug

public LocalizedString getSlug()

User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_\\-]{2,256}.

Returns:

slug

getMetaTitle

@Nullable
public LocalizedString getMetaTitle()

Title of the Product displayed in search results.

Returns:

metaTitle

getMetaDescription

@Nullable
public LocalizedString getMetaDescription()

Description of the Product displayed in search results below the meta title.

Returns:

metaDescription

getMetaKeywords

@Nullable
public LocalizedString getMetaKeywords()

Keywords that give additional information about the Product to search engines.

Returns:

metaKeywords

getMasterVariant

public ProductVariant getMasterVariant()

The Master Variant of the Product.

Returns:

masterVariant

getVariants

public List<ProductVariant> getVariants()

Additional Product Variants.

Returns:

variants

getSearchKeywords

public SearchKeywords getSearchKeywords()

Used by Product Suggestions, but is also considered for a full text search.

Returns:

searchKeywords

build

public ProductData build()

builds ProductData with checking for non-null required values

Specified by:

build in interface Builder<ProductData>

Returns:

ProductData

buildUnchecked

public ProductData buildUnchecked()

builds ProductData without checking for non-null required values

Returns:

ProductData

of

public static ProductDataBuilder of()

factory method for an instance of ProductDataBuilder

Returns:

builder

of

public static ProductDataBuilder of(ProductData template)

create builder for ProductData instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder