Package com.commercetools.importapi.models.customfields

Interface DateField

All Superinterfaces:

CustomField

public interface DateField
extends CustomField

A field with a date value.

Example to create an instance using the builder pattern

     DateField dateField = DateField.builder()
             .value(LocalDate.parse("2022-01-01"))
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE	discriminator value for DateField

Method Summary

Modifier and Type	Method	Description
static DateFieldBuilder	builder()	builder factory method for DateField
static DateFieldBuilder	builder(DateField template)	create builder for DateField instance
DateField	copyDeep()
static DateField	deepCopy(DateField template)	factory method to create a deep copy of DateField
@NotNull LocalDate	getValue()	A date in the format YYYY-MM-DD.
static DateField	of()	factory method
static DateField	of(DateField template)	factory method to create a shallow copy DateField
void	setValue(LocalDate value)	A date in the format YYYY-MM-DD.
static com.fasterxml.jackson.core.type.TypeReference<DateField>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDateField(Function<DateField,T> helper)	accessor map function

Methods inherited from interface com.commercetools.importapi.models.customfields.CustomField

getType, withCustomField

Field Details

DATE

static final String DATE

discriminator value for DateField

See Also:

• Constant Field Values

Method Details

getValue

@NotNull
@NotNull LocalDate getValue()

A date in the format YYYY-MM-DD.

Returns:

value

setValue

void setValue(LocalDate value)

A date in the format YYYY-MM-DD.

Parameters:

value - value to be set

of

static DateField of()

factory method

Returns:

instance of DateField

of

static DateField of(DateField template)

factory method to create a shallow copy DateField

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DateField copyDeep()

Specified by:

copyDeep in interface CustomField

deepCopy

@Nullable
static DateField deepCopy(@Nullable
 DateField template)

factory method to create a deep copy of DateField

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DateFieldBuilder builder()

builder factory method for DateField

Returns:

builder

builder

static DateFieldBuilder builder(DateField template)

create builder for DateField instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDateField

default <T> T withDateField(Function<DateField,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<DateField> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference