Package com.commercetools.api.models.product

Interface CustomTokenizer

All Superinterfaces:

SuggestTokenizer

All Known Implementing Classes:

CustomTokenizerImpl

public interface CustomTokenizer
extends SuggestTokenizer

Define arbitrary tokens that are used to match the input.

Example to create an instance using the builder pattern

     CustomTokenizer customTokenizer = CustomTokenizer.builder()
             .plusInputs(inputsBuilder -> inputsBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM	discriminator value for CustomTokenizer

Method Summary

Modifier and Type	Method	Description
static CustomTokenizerBuilder	builder()	builder factory method for CustomTokenizer
static CustomTokenizerBuilder	builder(CustomTokenizer template)	create builder for CustomTokenizer instance
static CustomTokenizer	deepCopy(CustomTokenizer template)	factory method to create a deep copy of CustomTokenizer
@NotNull List<String>	getInputs()	Contains custom tokens.
static CustomTokenizer	of()	factory method
static CustomTokenizer	of(CustomTokenizer template)	factory method to create a shallow copy CustomTokenizer
void	setInputs(String... inputs)	Contains custom tokens.
void	setInputs(List<String> inputs)	Contains custom tokens.
static com.fasterxml.jackson.core.type.TypeReference<CustomTokenizer>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomTokenizer(Function<CustomTokenizer,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product.SuggestTokenizer

getType, withSuggestTokenizer

Field Details

CUSTOM

static final String CUSTOM

discriminator value for CustomTokenizer

See Also:

• Constant Field Values

Method Details

getInputs

@NotNull
@NotNull List<String> getInputs()

Contains custom tokens.

Returns:

inputs

setInputs

void setInputs(String... inputs)

Contains custom tokens.

Parameters:

inputs - values to be set

setInputs

void setInputs(List<String> inputs)

Contains custom tokens.

Parameters:

inputs - values to be set

of

static CustomTokenizer of()

factory method

Returns:

instance of CustomTokenizer

of

static CustomTokenizer of(CustomTokenizer template)

factory method to create a shallow copy CustomTokenizer

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomTokenizer deepCopy(@Nullable
 CustomTokenizer template)

factory method to create a deep copy of CustomTokenizer

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomTokenizerBuilder builder()

builder factory method for CustomTokenizer

Returns:

builder

builder

static CustomTokenizerBuilder builder(CustomTokenizer template)

create builder for CustomTokenizer instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomTokenizer

default <T> T withCustomTokenizer(Function<CustomTokenizer,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<CustomTokenizer> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference