Package com.commercetools.api.models.category

Class CategoryBuilder

java.lang.Object

com.commercetools.api.models.category.CategoryBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<Category>

public class CategoryBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<Category>

CategoryBuilder Example to create an instance using the builder pattern

     Category category = Category.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .name(nameBuilder -> nameBuilder)
             .slug(slugBuilder -> slugBuilder)
             .plusAncestors(ancestorsBuilder -> ancestorsBuilder)
             .orderHint("{orderHint}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CategoryBuilder()

Method Summary

Modifier and Type	Method	Description
CategoryBuilder	addAncestors(Function<CategoryReferenceBuilder,CategoryReference> builder)	Contains the parent path towards the root Category.
CategoryBuilder	addAssets(Function<AssetBuilder,Asset> builder)	Media related to the Category.
CategoryBuilder	ancestors(CategoryReference... ancestors)	Contains the parent path towards the root Category.
CategoryBuilder	ancestors(List<CategoryReference> ancestors)	Contains the parent path towards the root Category.
CategoryBuilder	assets(Asset... assets)	Media related to the Category.
CategoryBuilder	assets(List<Asset> assets)	Media related to the Category.
Category	build()	builds Category with checking for non-null required values
Category	buildUnchecked()	builds Category without checking for non-null required values
CategoryBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Category was initially created.
CategoryBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
CategoryBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
CategoryBuilder	custom(CustomFields custom)	Custom Fields for the Category.
CategoryBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields for the Category.
CategoryBuilder	description(LocalizedString description)	Description of the Category.
CategoryBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the Category.
CategoryBuilder	externalId(String externalId)	Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
List<CategoryReference>	getAncestors()	Contains the parent path towards the root Category.
List<Asset>	getAssets()	Media related to the Category.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Category was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
CustomFields	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	getId()	Unique identifier of the Category.
String	getKey()	User-defined unique identifier of the Category.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the Category was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources updated after 1 February 2019 except for events not tracked.
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 used to order Categories that are on the same level in the Category tree.
CategoryReference	getParent()	Parent Category of this Category.
LocalizedString	getSlug()	User-defined identifier used as a deep-link URL to the related Category per Locale.
Long	getVersion()	Current version of the Category.
CategoryBuilder	id(String id)	Unique identifier of the Category.
CategoryBuilder	key(String key)	User-defined unique identifier of the Category.
CategoryBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the Category was last updated.
CategoryBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources updated after 1 February 2019 except for events not tracked.
CategoryBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources updated after 1 February 2019 except for events not tracked.
CategoryBuilder	metaDescription(LocalizedString metaDescription)	Description of the Category used by external search engines for improved search engine performance.
CategoryBuilder	metaDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the Category used by external search engines for improved search engine performance.
CategoryBuilder	metaKeywords(LocalizedString metaKeywords)	Keywords related to the Category for improved search engine performance.
CategoryBuilder	metaKeywords(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Keywords related to the Category for improved search engine performance.
CategoryBuilder	metaTitle(LocalizedString metaTitle)	Name of the Category used by external search engines for improved search engine performance.
CategoryBuilder	metaTitle(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Category used by external search engines for improved search engine performance.
CategoryBuilder	name(LocalizedString name)	Name of the Category.
CategoryBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Category.
static CategoryBuilder	of()	factory method for an instance of CategoryBuilder
static CategoryBuilder	of(Category template)	create builder for Category instance
CategoryBuilder	orderHint(String orderHint)	Decimal value between 0 and 1 used to order Categories that are on the same level in the Category tree.
CategoryBuilder	parent(CategoryReference parent)	Parent Category of this Category.
CategoryBuilder	parent(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)	Parent Category of this Category.
CategoryBuilder	plusAncestors(CategoryReference... ancestors)	Contains the parent path towards the root Category.
CategoryBuilder	plusAncestors(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)	Contains the parent path towards the root Category.
CategoryBuilder	plusAssets(Asset... assets)	Media related to the Category.
CategoryBuilder	plusAssets(Function<AssetBuilder,AssetBuilder> builder)	Media related to the Category.
CategoryBuilder	setAncestors(Function<CategoryReferenceBuilder,CategoryReference> builder)	Contains the parent path towards the root Category.
CategoryBuilder	setAssets(Function<AssetBuilder,Asset> builder)	Media related to the Category.
CategoryBuilder	slug(LocalizedString slug)	User-defined identifier used as a deep-link URL to the related Category per Locale.
CategoryBuilder	slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	User-defined identifier used as a deep-link URL to the related Category per Locale.
CategoryBuilder	version(Long version)	Current version of the Category.
CategoryBuilder	withAncestors(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)	Contains the parent path towards the root Category.
CategoryBuilder	withAssets(Function<AssetBuilder,AssetBuilder> builder)	Media related to the Category.
CategoryBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
CategoryBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields for the Category.
CategoryBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the Category.
CategoryBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources updated after 1 February 2019 except for events not tracked.
CategoryBuilder	withMetaDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the Category used by external search engines for improved search engine performance.
CategoryBuilder	withMetaKeywords(Function<LocalizedStringBuilder,LocalizedString> builder)	Keywords related to the Category for improved search engine performance.
CategoryBuilder	withMetaTitle(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Category used by external search engines for improved search engine performance.
CategoryBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Category.
CategoryBuilder	withParent(Function<CategoryReferenceBuilder,CategoryReference> builder)	Parent Category of this Category.
CategoryBuilder	withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)	User-defined identifier used as a deep-link URL to the related Category per Locale.

Methods inherited from class java.lang.Object

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

Constructor Details

CategoryBuilder

public CategoryBuilder()

Method Details

id

public CategoryBuilder id(String id)

Unique identifier of the Category.

Parameters:

id - value to be set

Returns:

Builder

version

public CategoryBuilder version(Long version)

Current version of the Category.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public CategoryBuilder createdAt(ZonedDateTime createdAt)

Date and time (UTC) the Category was initially created.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public CategoryBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Date and time (UTC) the Category was last updated.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public CategoryBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

Present on resources updated after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

public CategoryBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

Present on resources updated after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public CategoryBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Present on resources updated after 1 February 2019 except for events not tracked.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public CategoryBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

public CategoryBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public CategoryBuilder createdBy(@Nullable
 CreatedBy createdBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

createdBy - value to be set

Returns:

Builder

name

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

Name of the Category.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the Category.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public CategoryBuilder name(LocalizedString name)

Name of the Category.

Parameters:

name - value to be set

Returns:

Builder

slug

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

User-defined identifier used as a deep-link URL to the related Category per Locale. A Category can have the same slug for different Locales, but they are unique across the Project. Valid slugs match the pattern ^[A-Za-z0-9_-]{2,256}+$. For good performance, indexes are provided for the first 15 languages set in a Project.

Parameters:

builder - function to build the slug value

Returns:

Builder

withSlug

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

User-defined identifier used as a deep-link URL to the related Category per Locale. A Category can have the same slug for different Locales, but they are unique across the Project. Valid slugs match the pattern ^[A-Za-z0-9_-]{2,256}+$. For good performance, indexes are provided for the first 15 languages set in a Project.

Parameters:

builder - function to build the slug value

Returns:

Builder

slug

public CategoryBuilder slug(LocalizedString slug)

User-defined identifier used as a deep-link URL to the related Category per Locale. A Category can have the same slug for different Locales, but they are unique across the Project. Valid slugs match the pattern ^[A-Za-z0-9_-]{2,256}+$. For good performance, indexes are provided for the first 15 languages set in a Project.

Parameters:

slug - value to be set

Returns:

Builder

description

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

Description of the Category.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

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

Description of the Category.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public CategoryBuilder description(@Nullable
 LocalizedString description)

Description of the Category.

Parameters:

description - value to be set

Returns:

Builder

ancestors

public CategoryBuilder ancestors(CategoryReference... ancestors)

Contains the parent path towards the root Category.

Parameters:

ancestors - value to be set

Returns:

Builder

ancestors

public CategoryBuilder ancestors(List<CategoryReference> ancestors)

Contains the parent path towards the root Category.

Parameters:

ancestors - value to be set

Returns:

Builder

plusAncestors

public CategoryBuilder plusAncestors(CategoryReference... ancestors)

Contains the parent path towards the root Category.

Parameters:

ancestors - value to be set

Returns:

Builder

plusAncestors

public CategoryBuilder plusAncestors(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)

Contains the parent path towards the root Category.

Parameters:

builder - function to build the ancestors value

Returns:

Builder

withAncestors

public CategoryBuilder withAncestors(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)

Contains the parent path towards the root Category.

Parameters:

builder - function to build the ancestors value

Returns:

Builder

addAncestors

public CategoryBuilder addAncestors(Function<CategoryReferenceBuilder,CategoryReference> builder)

Contains the parent path towards the root Category.

Parameters:

builder - function to build the ancestors value

Returns:

Builder

setAncestors

public CategoryBuilder setAncestors(Function<CategoryReferenceBuilder,CategoryReference> builder)

Contains the parent path towards the root Category.

Parameters:

builder - function to build the ancestors value

Returns:

Builder

parent

public CategoryBuilder parent(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)

Parent Category of this Category.

Parameters:

builder - function to build the parent value

Returns:

Builder

withParent

public CategoryBuilder withParent(Function<CategoryReferenceBuilder,CategoryReference> builder)

Parent Category of this Category.

Parameters:

builder - function to build the parent value

Returns:

Builder

parent

public CategoryBuilder parent(@Nullable
 CategoryReference parent)

Parent Category of this Category.

Parameters:

parent - value to be set

Returns:

Builder

orderHint

public CategoryBuilder orderHint(String orderHint)

Decimal value between 0 and 1 used to order Categories that are on the same level in the Category tree.

Parameters:

orderHint - value to be set

Returns:

Builder

externalId

public CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder 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 CategoryBuilder metaKeywords(@Nullable
 LocalizedString metaKeywords)

Keywords related to the Category for improved search engine performance.

Parameters:

metaKeywords - value to be set

Returns:

Builder

custom

public CategoryBuilder custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

Custom Fields for the Category.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public CategoryBuilder withCustom(Function<CustomFieldsBuilder,CustomFields> builder)

Custom Fields for the Category.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CategoryBuilder custom(@Nullable
 CustomFields custom)

Custom Fields for the Category.

Parameters:

custom - value to be set

Returns:

Builder

assets

public CategoryBuilder assets(@Nullable
 Asset... assets)

Media related to the Category.

Parameters:

assets - value to be set

Returns:

Builder

assets

public CategoryBuilder assets(@Nullable
 List<Asset> assets)

Media related to the Category.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

public CategoryBuilder plusAssets(@Nullable
 Asset... assets)

Media related to the Category.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

public CategoryBuilder plusAssets(Function<AssetBuilder,AssetBuilder> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

withAssets

public CategoryBuilder withAssets(Function<AssetBuilder,AssetBuilder> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

addAssets

public CategoryBuilder addAssets(Function<AssetBuilder,Asset> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

setAssets

public CategoryBuilder setAssets(Function<AssetBuilder,Asset> builder)

Media related to the Category.

Parameters:

builder - function to build the assets value

Returns:

Builder

key

public CategoryBuilder key(@Nullable
 String key)

User-defined unique identifier of the Category.

Parameters:

key - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the Category.

Returns:

id

getVersion

public Long getVersion()

Current version of the Category.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the Category was initially created.

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Date and time (UTC) the Category was last updated.

Returns:

lastModifiedAt

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

Present on resources updated after 1 February 2019 except for events not tracked.

Returns:

lastModifiedBy

getCreatedBy

@Nullable
public CreatedBy getCreatedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

createdBy

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 per Locale. A Category can have the same slug for different Locales, but they are unique across the Project. Valid slugs match the pattern ^[A-Za-z0-9_-]{2,256}+$. For good performance, indexes are provided for the first 15 languages set in a Project.

Returns:

slug

getDescription

@Nullable
public LocalizedString getDescription()

Description of the Category.

Returns:

description

getAncestors

public List<CategoryReference> getAncestors()

Contains the parent path towards the root Category.

Returns:

ancestors

getParent

@Nullable
public CategoryReference getParent()

Parent Category of this Category.

Returns:

parent

getOrderHint

public String getOrderHint()

Decimal value between 0 and 1 used to order Categories that are on the same level in the Category tree.

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 CustomFields getCustom()

Custom Fields for the Category.

Returns:

custom

getAssets

@Nullable
public List<Asset> getAssets()

Media related to the Category.

Returns:

assets

getKey

@Nullable
public String getKey()

User-defined unique identifier of the Category.

Returns:

key

build

public Category build()

builds Category with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<Category>

Returns:

Category

buildUnchecked

public Category buildUnchecked()

builds Category without checking for non-null required values

Returns:

Category

of

public static CategoryBuilder of()

factory method for an instance of CategoryBuilder

Returns:

builder

of

public static CategoryBuilder of(Category template)

create builder for Category instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder