Package com.commercetools.api.models.type

Class TypeBuilder

java.lang.Object

com.commercetools.api.models.type.TypeBuilder

All Implemented Interfaces:

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

public class TypeBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<Type>

TypeBuilder Example to create an instance using the builder pattern

     Type type = Type.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .key("{key}")
             .name(nameBuilder -> nameBuilder)
             .plusResourceTypeIds(resourceTypeIdsBuilder -> resourceTypeIdsBuilder)
             .plusFieldDefinitions(fieldDefinitionsBuilder -> fieldDefinitionsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
TypeBuilder()

Method Summary

Modifier and Type	Method	Description
TypeBuilder	addFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinition> builder)	Defines Custom Fields.
Type	build()	builds Type with checking for non-null required values
Type	buildUnchecked()	builds Type without checking for non-null required values
TypeBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Type was initially created.
TypeBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
TypeBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
TypeBuilder	description(LocalizedString description)	Description of the Type.
TypeBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the Type.
TypeBuilder	fieldDefinitions(FieldDefinition... fieldDefinitions)	Defines Custom Fields.
TypeBuilder	fieldDefinitions(List<FieldDefinition> fieldDefinitions)	Defines Custom Fields.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Type was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
LocalizedString	getDescription()	Description of the Type.
List<FieldDefinition>	getFieldDefinitions()	Defines Custom Fields.
String	getId()	Unique identifier of the Type.
String	getKey()	User-defined unique identifier of the Type.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the Type was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
LocalizedString	getName()	Name of the Type.
List<ResourceTypeId>	getResourceTypeIds()	Resources and/or data types for which the Type is defined.
Long	getVersion()	Current version of the Type.
TypeBuilder	id(String id)	Unique identifier of the Type.
TypeBuilder	key(String key)	User-defined unique identifier of the Type.
TypeBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the Type was last updated.
TypeBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
TypeBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
TypeBuilder	name(LocalizedString name)	Name of the Type.
TypeBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Type.
static TypeBuilder	of()	factory method for an instance of TypeBuilder
static TypeBuilder	of(Type template)	create builder for Type instance
TypeBuilder	plusFieldDefinitions(FieldDefinition... fieldDefinitions)	Defines Custom Fields.
TypeBuilder	plusFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinitionBuilder> builder)	Defines Custom Fields.
TypeBuilder	plusResourceTypeIds(ResourceTypeId... resourceTypeIds)	Resources and/or data types for which the Type is defined.
TypeBuilder	resourceTypeIds(ResourceTypeId... resourceTypeIds)	Resources and/or data types for which the Type is defined.
TypeBuilder	resourceTypeIds(List<ResourceTypeId> resourceTypeIds)	Resources and/or data types for which the Type is defined.
TypeBuilder	setFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinition> builder)	Defines Custom Fields.
TypeBuilder	version(Long version)	Current version of the Type.
TypeBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
TypeBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the Type.
TypeBuilder	withFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinitionBuilder> builder)	Defines Custom Fields.
TypeBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
TypeBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Type.

Methods inherited from class java.lang.Object

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

Constructor Details

TypeBuilder

public TypeBuilder()

Method Details

id

public TypeBuilder id(String id)

Unique identifier of the Type.

Parameters:

id - value to be set

Returns:

Builder

version

public TypeBuilder version(Long version)

Current version of the Type.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public TypeBuilder createdAt(ZonedDateTime createdAt)

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

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public TypeBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

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

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

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

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

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

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public TypeBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

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

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public TypeBuilder 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 TypeBuilder 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 TypeBuilder 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

key

public TypeBuilder key(String key)

User-defined unique identifier of the Type.

Parameters:

key - value to be set

Returns:

Builder

name

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

Name of the Type.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the Type.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public TypeBuilder name(LocalizedString name)

Name of the Type.

Parameters:

name - value to be set

Returns:

Builder

description

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

Description of the Type.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

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

Description of the Type.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public TypeBuilder description(@Nullable
 LocalizedString description)

Description of the Type.

Parameters:

description - value to be set

Returns:

Builder

resourceTypeIds

public TypeBuilder resourceTypeIds(ResourceTypeId... resourceTypeIds)

Resources and/or data types for which the Type is defined.

Parameters:

resourceTypeIds - value to be set

Returns:

Builder

resourceTypeIds

public TypeBuilder resourceTypeIds(List<ResourceTypeId> resourceTypeIds)

Resources and/or data types for which the Type is defined.

Parameters:

resourceTypeIds - value to be set

Returns:

Builder

plusResourceTypeIds

public TypeBuilder plusResourceTypeIds(ResourceTypeId... resourceTypeIds)

Resources and/or data types for which the Type is defined.

Parameters:

resourceTypeIds - value to be set

Returns:

Builder

fieldDefinitions

public TypeBuilder fieldDefinitions(FieldDefinition... fieldDefinitions)

Defines Custom Fields.

Parameters:

fieldDefinitions - value to be set

Returns:

Builder

fieldDefinitions

public TypeBuilder fieldDefinitions(List<FieldDefinition> fieldDefinitions)

Defines Custom Fields.

Parameters:

fieldDefinitions - value to be set

Returns:

Builder

plusFieldDefinitions

public TypeBuilder plusFieldDefinitions(FieldDefinition... fieldDefinitions)

Defines Custom Fields.

Parameters:

fieldDefinitions - value to be set

Returns:

Builder

plusFieldDefinitions

public TypeBuilder plusFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinitionBuilder> builder)

Defines Custom Fields.

Parameters:

builder - function to build the fieldDefinitions value

Returns:

Builder

withFieldDefinitions

public TypeBuilder withFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinitionBuilder> builder)

Defines Custom Fields.

Parameters:

builder - function to build the fieldDefinitions value

Returns:

Builder

addFieldDefinitions

public TypeBuilder addFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinition> builder)

Defines Custom Fields.

Parameters:

builder - function to build the fieldDefinitions value

Returns:

Builder

setFieldDefinitions

public TypeBuilder setFieldDefinitions(Function<FieldDefinitionBuilder,FieldDefinition> builder)

Defines Custom Fields.

Parameters:

builder - function to build the fieldDefinitions value

Returns:

Builder

getId

public String getId()

Unique identifier of the Type.

Returns:

id

getVersion

public Long getVersion()

Current version of the Type.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

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

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

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

Returns:

lastModifiedAt

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

Present on resources created 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

getKey

public String getKey()

User-defined unique identifier of the Type.

Returns:

key

getName

public LocalizedString getName()

Name of the Type.

Returns:

name

getDescription

@Nullable
public LocalizedString getDescription()

Description of the Type.

Returns:

description

getResourceTypeIds

public List<ResourceTypeId> getResourceTypeIds()

Resources and/or data types for which the Type is defined.

Returns:

resourceTypeIds

getFieldDefinitions

public List<FieldDefinition> getFieldDefinitions()

Defines Custom Fields.

Returns:

fieldDefinitions

build

public Type build()

builds Type with checking for non-null required values

Specified by:

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

Returns:

Type

buildUnchecked

public Type buildUnchecked()

builds Type without checking for non-null required values

Returns:

Type

of

public static TypeBuilder of()

factory method for an instance of TypeBuilder

Returns:

builder

of

public static TypeBuilder of(Type template)

create builder for Type instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder