Package com.commercetools.importapi.models.common

Interface LocalizedString

All Known Implementing Classes:

LocalizedStringImpl

public interface LocalizedString

A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.

{
    "de": "Hundefutter",
    "en": "dog food"
  }
  

Example to create an instance using the builder pattern

     LocalizedString localizedString = LocalizedString.builder()
             ./^[a-z]{2}(-[A-Z]{2})?$/("{/^[a-z]{2}(-[A-Z]{2})?$/}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static LocalizedStringBuilder	builder()	builder factory method for LocalizedString
static LocalizedStringBuilder	builder(LocalizedString template)	create builder for LocalizedString instance
static LocalizedString	deepCopy(LocalizedString template)	factory method to create a deep copy of LocalizedString
static LocalizedString	of()	factory method
static LocalizedString	of(LocalizedString template)	factory method to create a shallow copy LocalizedString
void	setValue(String key, String value)	set pattern property
static com.fasterxml.jackson.core.type.TypeReference<LocalizedString>	typeReference()	gives a TypeReference for usage with Jackson DataBind
@NotNull Map<String,String>	values()
default <T> T	withLocalizedString(Function<LocalizedString,T> helper)	accessor map function

Method Details

values

@NotNull
@NotNull Map<String,String> values()

Returns:

map of the pattern property values

setValue

void setValue(String key,
 String value)

set pattern property

Parameters:

key - property name

value - property value

of

static LocalizedString of()

factory method

Returns:

instance of LocalizedString

of

static LocalizedString of(LocalizedString template)

factory method to create a shallow copy LocalizedString

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static LocalizedString deepCopy(@Nullable
 LocalizedString template)

factory method to create a deep copy of LocalizedString

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static LocalizedStringBuilder builder()

builder factory method for LocalizedString

Returns:

builder

builder

static LocalizedStringBuilder builder(LocalizedString template)

create builder for LocalizedString instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withLocalizedString

default <T> T withLocalizedString(Function<LocalizedString,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<LocalizedString> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference