Package com.commercetools.api.models.project

Interface ProjectUpdate

All Superinterfaces:

ResourceUpdate<ProjectUpdate,ProjectUpdateAction,ProjectUpdateBuilder>

public interface ProjectUpdate
extends ResourceUpdate<ProjectUpdate,ProjectUpdateAction,ProjectUpdateBuilder>

ProjectUpdate Example to create an instance using the builder pattern

     ProjectUpdate projectUpdate = ProjectUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ProjectUpdateBuilder	builder()	builder factory method for ProjectUpdate
static ProjectUpdateBuilder	builder(ProjectUpdate template)	create builder for ProjectUpdate instance
ProjectUpdate	copyDeep()
static ProjectUpdate	deepCopy(ProjectUpdate template)	factory method to create a deep copy of ProjectUpdate
@NotNull @Valid List<ProjectUpdateAction>	getActions()	Update actions to be performed on the Project.
@NotNull Long	getVersion()	Expected version of the Project on which the changes should be applied.
static ProjectUpdate	of()	factory method
static ProjectUpdate	of(ProjectUpdate template)	factory method to create a shallow copy ProjectUpdate
void	setActions(ProjectUpdateAction... actions)	Update actions to be performed on the Project.
void	setActions(List<ProjectUpdateAction> actions)	Update actions to be performed on the Project.
void	setVersion(Long version)	Expected version of the Project on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<ProjectUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProjectUpdate(Function<ProjectUpdate,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdate

get

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

Expected version of the Project on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

getVersion in interface ResourceUpdate<ProjectUpdate,ProjectUpdateAction,ProjectUpdateBuilder>

Returns:

version

getActions

@NotNull
@Valid
@NotNull @Valid List<ProjectUpdateAction> getActions()

Update actions to be performed on the Project.

Specified by:

getActions in interface ResourceUpdate<ProjectUpdate,ProjectUpdateAction,ProjectUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

Expected version of the Project on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

setVersion in interface ResourceUpdate<ProjectUpdate,ProjectUpdateAction,ProjectUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(ProjectUpdateAction... actions)

Update actions to be performed on the Project.

Parameters:

actions - values to be set

setActions

void setActions(List<ProjectUpdateAction> actions)

Update actions to be performed on the Project.

Specified by:

setActions in interface ResourceUpdate<ProjectUpdate,ProjectUpdateAction,ProjectUpdateBuilder>

Parameters:

actions - values to be set

of

static ProjectUpdate of()

factory method

Returns:

instance of ProjectUpdate

of

static ProjectUpdate of(ProjectUpdate template)

factory method to create a shallow copy ProjectUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProjectUpdate copyDeep()

deepCopy

@Nullable
static ProjectUpdate deepCopy(@Nullable
 ProjectUpdate template)

factory method to create a deep copy of ProjectUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProjectUpdateBuilder builder()

builder factory method for ProjectUpdate

Returns:

builder

builder

static ProjectUpdateBuilder builder(ProjectUpdate template)

create builder for ProjectUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProjectUpdate

default <T> T withProjectUpdate(Function<ProjectUpdate,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ProjectUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference