Package com.commercetools.importapi.models.customfields

Interface TimeField

All Superinterfaces:

CustomField

public interface TimeField
extends CustomField

A field with a time value.

Example to create an instance using the builder pattern

     TimeField timeField = TimeField.builder()
             .value(LocalTime.parse("12:00:00.301"))
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TIME	discriminator value for TimeField

Method Summary

Modifier and Type	Method	Description
static TimeFieldBuilder	builder()	builder factory method for TimeField
static TimeFieldBuilder	builder(TimeField template)	create builder for TimeField instance
TimeField	copyDeep()
static TimeField	deepCopy(TimeField template)	factory method to create a deep copy of TimeField
@NotNull LocalTime	getValue()	A time value in the format HH:mm:ss.SSS.
static TimeField	of()	factory method
static TimeField	of(TimeField template)	factory method to create a shallow copy TimeField
void	setValue(LocalTime value)	A time value in the format HH:mm:ss.SSS.
static com.fasterxml.jackson.core.type.TypeReference<TimeField>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTimeField(Function<TimeField,T> helper)	accessor map function

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

getType, withCustomField

Field Details

TIME

static final String TIME

discriminator value for TimeField

See Also:

• Constant Field Values

Method Details

getValue

@NotNull
@NotNull LocalTime getValue()

A time value in the format HH:mm:ss.SSS. 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(LocalTime value)

A time value in the format HH:mm:ss.SSS. 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 TimeField of()

factory method

Returns:

instance of TimeField

of

static TimeField of(TimeField template)

factory method to create a shallow copy TimeField

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

TimeField copyDeep()

Specified by:

copyDeep in interface CustomField

deepCopy

@Nullable
static TimeField deepCopy(@Nullable
 TimeField template)

factory method to create a deep copy of TimeField

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TimeFieldBuilder builder()

builder factory method for TimeField

Returns:

builder

builder

static TimeFieldBuilder builder(TimeField template)

create builder for TimeField instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTimeField

default <T> T withTimeField(Function<TimeField,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<TimeField> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference