Package com.commercetools.api.models.category

Class CategoryDraftBuilder

java.lang.Object

com.commercetools.api.models.category.CategoryDraftBuilder

All Implemented Interfaces:

Builder<CategoryDraft>

public class CategoryDraftBuilder
extends Object
implements Builder<CategoryDraft>

CategoryDraftBuilder Example to create an instance using the builder pattern

     CategoryDraft categoryDraft = CategoryDraft.builder()
             .name(nameBuilder -> nameBuilder)
             .slug(slugBuilder -> slugBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CategoryDraftBuilder()

Method Summary

Modifier and Type	Method	Description
CategoryDraftBuilder	addAssets(Function<AssetDraftBuilder,AssetDraft> builder)	Media related to the Category.
CategoryDraftBuilder	assets(AssetDraft... assets)	Media related to the Category.
CategoryDraftBuilder	assets(List<AssetDraft> assets)	Media related to the Category.
CategoryDraft	build()	builds CategoryDraft with checking for non-null required values
CategoryDraft	buildUnchecked()	builds CategoryDraft without checking for non-null required values
CategoryDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Category.
CategoryDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Category.
CategoryDraftBuilder	description(LocalizedString description)	Description of the Category.
CategoryDraftBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the Category.
CategoryDraftBuilder	externalId(String externalId)	Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
List<AssetDraft>	getAssets()	Media related to the Category.
CustomFieldsDraft	getCustom()	Custom Fields for the Category.
LocalizedString	getDescription()	Description of the Category.
String	getExternalId()	Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
String	getKey()	User-defined unique identifier for the Category.
LocalizedString	getMetaDescription()	Description of the Category used by external search engines for improved search engine performance.
LocalizedString	getMetaKeywords()	Keywords related to the Category for improved search engine performance.
LocalizedString	getMetaTitle()	Name of the Category used by external search engines for improved search engine performance.
LocalizedString	getName()	Name of the Category.
String	getOrderHint()	Decimal value between 0 and 1.
CategoryResourceIdentifier	getParent()	Parent Category of the Category.
LocalizedString	getSlug()	User-defined identifier used as a deep-link URL to the related Category.
CategoryDraftBuilder	key(String key)	User-defined unique identifier for the Category.
CategoryDraftBuilder	metaDescription(LocalizedString metaDescription)	Description of the Category used by external search engines for improved search engine performance.
CategoryDraftBuilder	metaDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the Category used by external search engines for improved search engine performance.
CategoryDraftBuilder	metaKeywords(LocalizedString metaKeywords)	Keywords related to the Category for improved search engine performance.
CategoryDraftBuilder	metaKeywords(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Keywords related to the Category for improved search engine performance.
CategoryDraftBuilder	metaTitle(LocalizedString metaTitle)	Name of the Category used by external search engines for improved search engine performance.
CategoryDraftBuilder	metaTitle(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Category used by external search engines for improved search engine performance.
CategoryDraftBuilder	name(LocalizedString name)	Name of the Category.
CategoryDraftBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Category.
static CategoryDraftBuilder	of()	factory method for an instance of CategoryDraftBuilder
static CategoryDraftBuilder	of(CategoryDraft template)	create builder for CategoryDraft instance
CategoryDraftBuilder	orderHint(String orderHint)	Decimal value between 0 and 1.
CategoryDraftBuilder	parent(CategoryResourceIdentifier parent)	Parent Category of the Category.
CategoryDraftBuilder	parent(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifierBuilder> builder)	Parent Category of the Category.
CategoryDraftBuilder	plusAssets(AssetDraft... assets)	Media related to the Category.
CategoryDraftBuilder	plusAssets(Function<AssetDraftBuilder,AssetDraftBuilder> builder)	Media related to the Category.
CategoryDraftBuilder	setAssets(Function<AssetDraftBuilder,AssetDraft> builder)	Media related to the Category.
CategoryDraftBuilder	slug(LocalizedString slug)	User-defined identifier used as a deep-link URL to the related Category.
CategoryDraftBuilder	slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	User-defined identifier used as a deep-link URL to the related Category.
CategoryDraftBuilder	withAssets(Function<AssetDraftBuilder,AssetDraftBuilder> builder)	Media related to the Category.
CategoryDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Category.
CategoryDraftBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the Category.
CategoryDraftBuilder	withMetaDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the Category used by external search engines for improved search engine performance.
CategoryDraftBuilder	withMetaKeywords(Function<LocalizedStringBuilder,LocalizedString> builder)	Keywords related to the Category for improved search engine performance.
CategoryDraftBuilder	withMetaTitle(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Category used by external search engines for improved search engine performance.
CategoryDraftBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Category.
CategoryDraftBuilder	withParent(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifier> builder)	Parent Category of the Category.
CategoryDraftBuilder	withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)	User-defined identifier used as a deep-link URL to the related Category.

Methods inherited from class java.lang.Object

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

Constructor Details

CategoryDraftBuilder

public CategoryDraftBuilder()

Method Details

name

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

Name of the Category.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the Category.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public CategoryDraftBuilder name(LocalizedString name)

Name of the Category.

Parameters:

name - value to be set

Returns:

Builder

slug

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

User-defined identifier used as a deep-link URL to the related Category. A Category can have the same slug for different Locales, but it must be unique across the Project. Valid slugs must match the pattern ^[A-Za-z0-9_-]{2,256}+$.

Parameters:

builder - function to build the slug value

Returns:

Builder

withSlug

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

User-defined identifier used as a deep-link URL to the related Category. A Category can have the same slug for different Locales, but it must be unique across the Project. Valid slugs must match the pattern ^[A-Za-z0-9_-]{2,256}+$.

Parameters:

builder - function to build the slug value

Returns:

Builder

slug

public CategoryDraftBuilder slug(LocalizedString slug)

User-defined identifier used as a deep-link URL to the related Category. A Category can have the same slug for different Locales, but it must be unique across the Project. Valid slugs must match the pattern ^[A-Za-z0-9_-]{2,256}+$.

Parameters:

slug - value to be set

Returns:

Builder

description

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

Description of the Category.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

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

Description of the Category.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public CategoryDraftBuilder description(@Nullable
 LocalizedString description)

Description of the Category.

Parameters:

description - value to be set

Returns:

Builder

parent

public CategoryDraftBuilder parent(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifierBuilder> builder)

Parent Category of the Category. The parent can be set by its id or key.

Parameters:

builder - function to build the parent value

Returns:

Builder

withParent

public CategoryDraftBuilder withParent(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifier> builder)

Parent Category of the Category. The parent can be set by its id or key.

Parameters:

builder - function to build the parent value

Returns:

Builder

parent

public CategoryDraftBuilder parent(@Nullable
 CategoryResourceIdentifier parent)

Parent Category of the Category. The parent can be set by its id or key.

Parameters:

parent - value to be set

Returns:

Builder

orderHint

public CategoryDraftBuilder orderHint(@Nullable
 String orderHint)

Decimal value between 0 and 1. Frontend applications can use this value for ordering Categories within the same level in the category tree. If not set, a random value will be assigned.

Parameters:

orderHint - value to be set

Returns:

Builder

externalId

public CategoryDraftBuilder externalId(@Nullable
 String externalId)

Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).

Parameters:

externalId - value to be set

Returns:

Builder

metaTitle

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

Name of the Category used by external search engines for improved search engine performance.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

withMetaTitle

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

Name of the Category used by external search engines for improved search engine performance.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

metaTitle

public CategoryDraftBuilder metaTitle(@Nullable
 LocalizedString metaTitle)

Name of the Category used by external search engines for improved search engine performance.

Parameters:

metaTitle - value to be set

Returns:

Builder

metaDescription

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

Description of the Category used by external search engines for improved search engine performance.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

withMetaDescription

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

Description of the Category used by external search engines for improved search engine performance.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

metaDescription

public CategoryDraftBuilder metaDescription(@Nullable
 LocalizedString metaDescription)

Description of the Category used by external search engines for improved search engine performance.

Parameters:

metaDescription - value to be set

Returns:

Builder

metaKeywords

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

Keywords related to the Category for improved search engine performance.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

withMetaKeywords

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

Keywords related to the Category for improved search engine performance.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

metaKeywords

public CategoryDraftBuilder metaKeywords(@Nullable
 LocalizedString metaKeywords)

Keywords related to the Category for improved search engine performance.

Parameters:

metaKeywords - value to be set

Returns:

Builder

custom

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

Custom Fields for the Category.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Category.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CategoryDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Category.

Parameters:

custom - value to be set

Returns:

Builder

assets

public CategoryDraftBuilder assets(@Nullable
 AssetDraft... assets)

Media related to the Category.

Parameters:

assets - value to be set

Returns:

Builder

assets

public CategoryDraftBuilder assets(@Nullable
 List<AssetDraft> assets)

Media related to the Category.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

public CategoryDraftBuilder plusAssets(@Nullable
 AssetDraft... assets)

Media related to the Category.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

public CategoryDraftBuilder plusAssets(Function<AssetDraftBuilder,AssetDraftBuilder> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

withAssets

public CategoryDraftBuilder withAssets(Function<AssetDraftBuilder,AssetDraftBuilder> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

addAssets

public CategoryDraftBuilder addAssets(Function<AssetDraftBuilder,AssetDraft> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

setAssets

public CategoryDraftBuilder setAssets(Function<AssetDraftBuilder,AssetDraft> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

key

public CategoryDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the Category.

This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Categories with the Import API and the Merchant Center.

Parameters:

key - value to be set

Returns:

Builder

getName

public LocalizedString getName()

Name of the Category.

Returns:

name

getSlug

public LocalizedString getSlug()

User-defined identifier used as a deep-link URL to the related Category. A Category can have the same slug for different Locales, but it must be unique across the Project. Valid slugs must match the pattern ^[A-Za-z0-9_-]{2,256}+$.

Returns:

slug

getDescription

@Nullable
public LocalizedString getDescription()

Description of the Category.

Returns:

description

getParent

@Nullable
public CategoryResourceIdentifier getParent()

Parent Category of the Category. The parent can be set by its id or key.

Returns:

parent

getOrderHint

@Nullable
public String getOrderHint()

Decimal value between 0 and 1. Frontend applications can use this value for ordering Categories within the same level in the category tree. If not set, a random value will be assigned.

Returns:

orderHint

getExternalId

@Nullable
public String getExternalId()

Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).

Returns:

externalId

getMetaTitle

@Nullable
public LocalizedString getMetaTitle()

Name of the Category used by external search engines for improved search engine performance.

Returns:

metaTitle

getMetaDescription

@Nullable
public LocalizedString getMetaDescription()

Description of the Category used by external search engines for improved search engine performance.

Returns:

metaDescription

getMetaKeywords

@Nullable
public LocalizedString getMetaKeywords()

Keywords related to the Category for improved search engine performance.

Returns:

metaKeywords

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Category.

Returns:

custom

getAssets

@Nullable
public List<AssetDraft> getAssets()

Media related to the Category.

Returns:

assets

getKey

@Nullable
public String getKey()

User-defined unique identifier for the Category.

This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Categories with the Import API and the Merchant Center.

Returns:

key

build

public CategoryDraft build()

builds CategoryDraft with checking for non-null required values

Specified by:

build in interface Builder<CategoryDraft>

Returns:

CategoryDraft

buildUnchecked

public CategoryDraft buildUnchecked()

builds CategoryDraft without checking for non-null required values

Returns:

CategoryDraft

of

public static CategoryDraftBuilder of()

factory method for an instance of CategoryDraftBuilder

Returns:

builder

of

public static CategoryDraftBuilder of(CategoryDraft template)

create builder for CategoryDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder