Package com.commercetools.api.models.type

Interface TypeResourceIdentifier

All Superinterfaces:

Identifiable<Type>, ResourceIdentifier, WithKey

public interface TypeResourceIdentifier
extends ResourceIdentifier, Identifiable<Type>

ResourceIdentifier of a Type. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

Example to create an instance using the builder pattern

     TypeResourceIdentifier typeResourceIdentifier = TypeResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	discriminator value for TypeResourceIdentifier

Method Summary

Modifier and Type	Method	Description
static TypeResourceIdentifierBuilder	builder()	builder factory method for TypeResourceIdentifier
static TypeResourceIdentifierBuilder	builder(TypeResourceIdentifier template)	create builder for TypeResourceIdentifier instance
TypeResourceIdentifier	copyDeep()
static TypeResourceIdentifier	deepCopy(TypeResourceIdentifier template)	factory method to create a deep copy of TypeResourceIdentifier
String	getId()	Unique identifier of the referenced Type.
String	getKey()	User-defined unique identifier of the referenced Type.
static TypeResourceIdentifier	of()	factory method
static TypeResourceIdentifier	of(TypeResourceIdentifier template)	factory method to create a shallow copy TypeResourceIdentifier
void	setId(String id)	Unique identifier of the referenced Type.
void	setKey(String key)	User-defined unique identifier of the referenced Type.
static com.fasterxml.jackson.core.type.TypeReference<TypeResourceIdentifier>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTypeResourceIdentifier(Function<TypeResourceIdentifier,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.ResourceIdentifier

getTypeId, withResourceIdentifier

Field Details

TYPE

static final String TYPE

discriminator value for TypeResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

Unique identifier of the referenced Type. Required if key is absent.

Specified by:

getId in interface Identifiable<Type>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced Type. Required if id is absent.

Specified by:

getKey in interface ResourceIdentifier

Specified by:

getKey in interface WithKey

Returns:

key

setId

void setId(String id)

Unique identifier of the referenced Type. Required if key is absent.

Specified by:

setId in interface ResourceIdentifier

Parameters:

id - value to be set

setKey

void setKey(String key)

User-defined unique identifier of the referenced Type. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static TypeResourceIdentifier of()

factory method

Returns:

instance of TypeResourceIdentifier

of

static TypeResourceIdentifier of(TypeResourceIdentifier template)

factory method to create a shallow copy TypeResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

TypeResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static TypeResourceIdentifier deepCopy(@Nullable
 TypeResourceIdentifier template)

factory method to create a deep copy of TypeResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TypeResourceIdentifierBuilder builder()

builder factory method for TypeResourceIdentifier

Returns:

builder

builder

static TypeResourceIdentifierBuilder builder(TypeResourceIdentifier template)

create builder for TypeResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTypeResourceIdentifier

default <T> T withTypeResourceIdentifier(Function<TypeResourceIdentifier,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<TypeResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference