Package com.commercetools.importapi.models.customfields

Interface DateTimeField

All Superinterfaces:

CustomField

public interface DateTimeField
extends CustomField

A field with a date time value.

Example to create an instance using the builder pattern

     DateTimeField dateTimeField = DateTimeField.builder()
             .value(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_TIME	discriminator value for DateTimeField

Method Summary

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

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

getType, withCustomField

Field Details

DATE_TIME

static final String DATE_TIME

discriminator value for DateTimeField

See Also:

• Constant Field Values

Method Details

getValue

@NotNull
@NotNull ZonedDateTime getValue()

A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.

Returns:

value

setValue

void setValue(ZonedDateTime value)

A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.

Parameters:

value - value to be set

of

static DateTimeField of()

factory method

Returns:

instance of DateTimeField

of

static DateTimeField of(DateTimeField template)

factory method to create a shallow copy DateTimeField

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DateTimeField copyDeep()

Specified by:

copyDeep in interface CustomField

deepCopy

@Nullable
static DateTimeField deepCopy(@Nullable
 DateTimeField template)

factory method to create a deep copy of DateTimeField

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DateTimeFieldBuilder builder()

builder factory method for DateTimeField

Returns:

builder

builder

static DateTimeFieldBuilder builder(DateTimeField template)

create builder for DateTimeField instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDateTimeField

default <T> T withDateTimeField(Function<DateTimeField,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<DateTimeField> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference