Package com.commercetools.api.models.product

Class ProductAddToCategoryActionBuilder

java.lang.Object

com.commercetools.api.models.product.ProductAddToCategoryActionBuilder

All Implemented Interfaces:

Builder<ProductAddToCategoryAction>

public class ProductAddToCategoryActionBuilder
extends Object
implements Builder<ProductAddToCategoryAction>

ProductAddToCategoryActionBuilder Example to create an instance using the builder pattern

     ProductAddToCategoryAction productAddToCategoryAction = ProductAddToCategoryAction.builder()
             .category(categoryBuilder -> categoryBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductAddToCategoryActionBuilder()

Method Summary

Modifier and Type	Method	Description
ProductAddToCategoryAction	build()	builds ProductAddToCategoryAction with checking for non-null required values
ProductAddToCategoryAction	buildUnchecked()	builds ProductAddToCategoryAction without checking for non-null required values
ProductAddToCategoryActionBuilder	category(CategoryResourceIdentifier category)	The Category to add.
ProductAddToCategoryActionBuilder	category(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifierBuilder> builder)	The Category to add.
CategoryResourceIdentifier	getCategory()	The Category to add.
String	getOrderHint()	A string representing a number between 0 and 1.
Boolean	getStaged()	If true, only the staged categories and categoryOrderHints are updated.
static ProductAddToCategoryActionBuilder	of()	factory method for an instance of ProductAddToCategoryActionBuilder
static ProductAddToCategoryActionBuilder	of(ProductAddToCategoryAction template)	create builder for ProductAddToCategoryAction instance
ProductAddToCategoryActionBuilder	orderHint(String orderHint)	A string representing a number between 0 and 1.
ProductAddToCategoryActionBuilder	staged(Boolean staged)	If true, only the staged categories and categoryOrderHints are updated.
ProductAddToCategoryActionBuilder	withCategory(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifier> builder)	The Category to add.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductAddToCategoryActionBuilder

public ProductAddToCategoryActionBuilder()

Method Details

category

public ProductAddToCategoryActionBuilder category(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifierBuilder> builder)

The Category to add.

Parameters:

builder - function to build the category value

Returns:

Builder

withCategory

public ProductAddToCategoryActionBuilder withCategory(Function<CategoryResourceIdentifierBuilder,CategoryResourceIdentifier> builder)

The Category to add.

Parameters:

builder - function to build the category value

Returns:

Builder

category

public ProductAddToCategoryActionBuilder category(CategoryResourceIdentifier category)

The Category to add.

Parameters:

category - value to be set

Returns:

Builder

orderHint

public ProductAddToCategoryActionBuilder orderHint(@Nullable
 String orderHint)

A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If empty, any existing value will be removed.

Parameters:

orderHint - value to be set

Returns:

Builder

staged

public ProductAddToCategoryActionBuilder staged(@Nullable
 Boolean staged)

If true, only the staged categories and categoryOrderHints are updated. If false, both the current and staged categories and categoryOrderHints are updated.

Parameters:

staged - value to be set

Returns:

Builder

getCategory

public CategoryResourceIdentifier getCategory()

The Category to add.

Returns:

category

getOrderHint

@Nullable
public String getOrderHint()

A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If empty, any existing value will be removed.

Returns:

orderHint

getStaged

@Nullable
public Boolean getStaged()

If true, only the staged categories and categoryOrderHints are updated. If false, both the current and staged categories and categoryOrderHints are updated.

Returns:

staged

build

public ProductAddToCategoryAction build()

builds ProductAddToCategoryAction with checking for non-null required values

Specified by:

build in interface Builder<ProductAddToCategoryAction>

Returns:

ProductAddToCategoryAction

buildUnchecked

public ProductAddToCategoryAction buildUnchecked()

builds ProductAddToCategoryAction without checking for non-null required values

Returns:

ProductAddToCategoryAction

of

public static ProductAddToCategoryActionBuilder of()

factory method for an instance of ProductAddToCategoryActionBuilder

Returns:

builder

of

public static ProductAddToCategoryActionBuilder of(ProductAddToCategoryAction template)

create builder for ProductAddToCategoryAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder