Package com.commercetools.api.models.shopping_list

Class ShoppingListRemoveTextLineItemActionBuilder

java.lang.Object

com.commercetools.api.models.shopping_list.ShoppingListRemoveTextLineItemActionBuilder

All Implemented Interfaces:

Builder<ShoppingListRemoveTextLineItemAction>

public class ShoppingListRemoveTextLineItemActionBuilder
extends Object
implements Builder<ShoppingListRemoveTextLineItemAction>

ShoppingListRemoveTextLineItemActionBuilder Example to create an instance using the builder pattern

     ShoppingListRemoveTextLineItemAction shoppingListRemoveTextLineItemAction = ShoppingListRemoveTextLineItemAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ShoppingListRemoveTextLineItemActionBuilder()

Method Summary

Modifier and Type	Method	Description
ShoppingListRemoveTextLineItemAction	build()	builds ShoppingListRemoveTextLineItemAction with checking for non-null required values
ShoppingListRemoveTextLineItemAction	buildUnchecked()	builds ShoppingListRemoveTextLineItemAction without checking for non-null required values
Long	getQuantity()	Amount to remove from the quantity of the TextLineItem.
String	getTextLineItemId()	The id of the TextLineItem to update.
String	getTextLineItemKey()	The key of the TextLineItem to update.
static ShoppingListRemoveTextLineItemActionBuilder	of()	factory method for an instance of ShoppingListRemoveTextLineItemActionBuilder
static ShoppingListRemoveTextLineItemActionBuilder	of(ShoppingListRemoveTextLineItemAction template)	create builder for ShoppingListRemoveTextLineItemAction instance
ShoppingListRemoveTextLineItemActionBuilder	quantity(Long quantity)	Amount to remove from the quantity of the TextLineItem.
ShoppingListRemoveTextLineItemActionBuilder	textLineItemId(String textLineItemId)	The id of the TextLineItem to update.
ShoppingListRemoveTextLineItemActionBuilder	textLineItemKey(String textLineItemKey)	The key of the TextLineItem to update.

Methods inherited from class java.lang.Object

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

Constructor Details

ShoppingListRemoveTextLineItemActionBuilder

public ShoppingListRemoveTextLineItemActionBuilder()

Method Details

textLineItemId

public ShoppingListRemoveTextLineItemActionBuilder textLineItemId(@Nullable
 String textLineItemId)

The id of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

textLineItemId - value to be set

Returns:

Builder

textLineItemKey

public ShoppingListRemoveTextLineItemActionBuilder textLineItemKey(@Nullable
 String textLineItemKey)

The key of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

textLineItemKey - value to be set

Returns:

Builder

quantity

public ShoppingListRemoveTextLineItemActionBuilder quantity(@Nullable
 Long quantity)

Amount to remove from the quantity of the TextLineItem. If not set, the TextLineItem is removed from the ShoppingList. If this value matches or exceeds the current quantity of the TextLineItem, the TextLineItem is removed from the ShoppingList.

Parameters:

quantity - value to be set

Returns:

Builder

getTextLineItemId

@Nullable
public String getTextLineItemId()

The id of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Returns:

textLineItemId

getTextLineItemKey

@Nullable
public String getTextLineItemKey()

The key of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Returns:

textLineItemKey

getQuantity

@Nullable
public Long getQuantity()

Amount to remove from the quantity of the TextLineItem. If not set, the TextLineItem is removed from the ShoppingList. If this value matches or exceeds the current quantity of the TextLineItem, the TextLineItem is removed from the ShoppingList.

Returns:

quantity

build

public ShoppingListRemoveTextLineItemAction build()

builds ShoppingListRemoveTextLineItemAction with checking for non-null required values

Specified by:

build in interface Builder<ShoppingListRemoveTextLineItemAction>

Returns:

ShoppingListRemoveTextLineItemAction

buildUnchecked

public ShoppingListRemoveTextLineItemAction buildUnchecked()

builds ShoppingListRemoveTextLineItemAction without checking for non-null required values

Returns:

ShoppingListRemoveTextLineItemAction

of

public static ShoppingListRemoveTextLineItemActionBuilder of()

factory method for an instance of ShoppingListRemoveTextLineItemActionBuilder

Returns:

builder

of

public static ShoppingListRemoveTextLineItemActionBuilder of(ShoppingListRemoveTextLineItemAction template)

create builder for ShoppingListRemoveTextLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder