Package com.commercetools.api.models.store

Interface StoreKeyReference

All Superinterfaces:

KeyReference, WithKey

All Known Implementing Classes:

StoreKeyReferenceImpl

public interface StoreKeyReference
extends KeyReference

Reference to a Store by its key.

Example to create an instance using the builder pattern

     StoreKeyReference storeKeyReference = StoreKeyReference.builder()
             .key("{key}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STORE	discriminator value for StoreKeyReference

Method Summary

Modifier and Type	Method	Description
static StoreKeyReferenceBuilder	builder()	builder factory method for StoreKeyReference
static StoreKeyReferenceBuilder	builder(StoreKeyReference template)	create builder for StoreKeyReference instance
static StoreKeyReference	deepCopy(StoreKeyReference template)	factory method to create a deep copy of StoreKeyReference
@NotNull String	getKey()	Unique and immutable key of the referenced Store.
static StoreKeyReference	of()	factory method
static StoreKeyReference	of(StoreKeyReference template)	factory method to create a shallow copy StoreKeyReference
void	setKey(String key)	Unique and immutable key of the referenced Store.
static com.fasterxml.jackson.core.type.TypeReference<StoreKeyReference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStoreKeyReference(Function<StoreKeyReference,T> helper)	accessor map function

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

getTypeId, withKeyReference

Field Details

STORE

static final String STORE

discriminator value for StoreKeyReference

See Also:

• Constant Field Values

Method Details

getKey

@NotNull
@NotNull String getKey()

Unique and immutable key of the referenced Store.

Specified by:

getKey in interface KeyReference

Specified by:

getKey in interface WithKey

Returns:

key

setKey

void setKey(String key)

Unique and immutable key of the referenced Store.

Specified by:

setKey in interface KeyReference

Parameters:

key - value to be set

of

static StoreKeyReference of()

factory method

Returns:

instance of StoreKeyReference

of

static StoreKeyReference of(StoreKeyReference template)

factory method to create a shallow copy StoreKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StoreKeyReference deepCopy(@Nullable
 StoreKeyReference template)

factory method to create a deep copy of StoreKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StoreKeyReferenceBuilder builder()

builder factory method for StoreKeyReference

Returns:

builder

builder

static StoreKeyReferenceBuilder builder(StoreKeyReference template)

create builder for StoreKeyReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStoreKeyReference

default <T> T withStoreKeyReference(Function<StoreKeyReference,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<StoreKeyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference