Package com.commercetools.history.models.common

Interface SearchKeyword

All Known Implementing Classes:

SearchKeywordImpl

public interface SearchKeyword

SearchKeyword Example to create an instance using the builder pattern

     SearchKeyword searchKeyword = SearchKeyword.builder()
             .text("{text}")
             .suggestTokenizer(suggestTokenizerBuilder -> suggestTokenizerBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static SearchKeywordBuilder	builder()	builder factory method for SearchKeyword
static SearchKeywordBuilder	builder(SearchKeyword template)	create builder for SearchKeyword instance
static SearchKeyword	deepCopy(SearchKeyword template)	factory method to create a deep copy of SearchKeyword
@NotNull @Valid SuggestTokenizer	getSuggestTokenizer()
@NotNull String	getText()
static SearchKeyword	of()	factory method
static SearchKeyword	of(SearchKeyword template)	factory method to create a shallow copy SearchKeyword
void	setSuggestTokenizer(SuggestTokenizer suggestTokenizer)	set suggestTokenizer
void	setText(String text)	set text
static com.fasterxml.jackson.core.type.TypeReference<SearchKeyword>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSearchKeyword(Function<SearchKeyword,T> helper)	accessor map function

Method Details

getText

@NotNull
@NotNull String getText()

Returns:

text

getSuggestTokenizer

@NotNull
@Valid
@NotNull @Valid SuggestTokenizer getSuggestTokenizer()

Returns:

suggestTokenizer

setText

void setText(String text)

set text

Parameters:

text - value to be set

setSuggestTokenizer

void setSuggestTokenizer(SuggestTokenizer suggestTokenizer)

set suggestTokenizer

Parameters:

suggestTokenizer - value to be set

of

static SearchKeyword of()

factory method

Returns:

instance of SearchKeyword

of

static SearchKeyword of(SearchKeyword template)

factory method to create a shallow copy SearchKeyword

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SearchKeyword deepCopy(@Nullable
 SearchKeyword template)

factory method to create a deep copy of SearchKeyword

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SearchKeywordBuilder builder()

builder factory method for SearchKeyword

Returns:

builder

builder

static SearchKeywordBuilder builder(SearchKeyword template)

create builder for SearchKeyword instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSearchKeyword

default <T> T withSearchKeyword(Function<SearchKeyword,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<SearchKeyword> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference