Package com.commercetools.ml.models.common

Interface Reference

All Known Subinterfaces:

CategoryReference, ProductReference, ProductTypeReference

All Known Implementing Classes:

CategoryReferenceImpl, ProductReferenceImpl, ProductTypeReferenceImpl, ReferenceImpl

public interface Reference

Reference Example to create a subtype instance using the builder pattern

     Reference reference = Reference.categoryBuilder()
             id("{id}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CategoryReferenceBuilder	categoryBuilder()	builder for category subtype
static Reference	deepCopy(Reference template)	factory method to create a deep copy of Reference
@NotNull String	getId()
@NotNull ReferenceTypeId	getTypeId()
static ProductReferenceBuilder	productBuilder()	builder for product subtype
static ProductTypeReferenceBuilder	productTypeBuilder()	builder for productType subtype
void	setId(String id)	set id
static com.fasterxml.jackson.core.type.TypeReference<Reference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withReference(Function<Reference,T> helper)	accessor map function

Method Details

getTypeId

@NotNull
@NotNull ReferenceTypeId getTypeId()

Returns:

typeId

getId

@NotNull
@NotNull String getId()

Returns:

id

setId

void setId(String id)

set id

Parameters:

id - value to be set

deepCopy

@Nullable
static Reference deepCopy(@Nullable
 Reference template)

factory method to create a deep copy of Reference

Parameters:

template - instance to be copied

Returns:

copy instance

categoryBuilder

static CategoryReferenceBuilder categoryBuilder()

builder for category subtype

Returns:

builder

productBuilder

static ProductReferenceBuilder productBuilder()

builder for product subtype

Returns:

builder

productTypeBuilder

static ProductTypeReferenceBuilder productTypeBuilder()

builder for productType subtype

Returns:

builder

withReference

default <T> T withReference(Function<Reference,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<Reference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference