Package com.commercetools.importapi.models.customfields

Interface CustomField

All Known Subinterfaces:

BooleanField, BooleanSetField, DateField, DateSetField, DateTimeField, DateTimeSetField, EnumField, EnumSetField, LocalizedEnumField, LocalizedEnumSetField, LocalizedStringField, LocalizedStringSetField, MoneyField, MoneySetField, NumberField, NumberSetField, ReferenceField, ReferenceSetField, StringField, StringSetField, TimeField, TimeSetField

All Known Implementing Classes:

BooleanFieldImpl, BooleanSetFieldImpl, CustomFieldImpl, DateFieldImpl, DateSetFieldImpl, DateTimeFieldImpl, DateTimeSetFieldImpl, EnumFieldImpl, EnumSetFieldImpl, LocalizedEnumFieldImpl, LocalizedEnumSetFieldImpl, LocalizedStringFieldImpl, LocalizedStringSetFieldImpl, MoneyFieldImpl, MoneySetFieldImpl, NumberFieldImpl, NumberSetFieldImpl, ReferenceFieldImpl, ReferenceSetFieldImpl, StringFieldImpl, StringSetFieldImpl, TimeFieldImpl, TimeSetFieldImpl

public interface CustomField

Provides the value for a custom field of a specific type.

Example to create a subtype instance using the builder pattern

     CustomField customField = CustomField.booleanBuilder()
             value(true)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static BooleanFieldBuilder	booleanBuilder()	builder for boolean subtype
static BooleanSetFieldBuilder	booleanSetBuilder()	builder for booleanSet subtype
static DateFieldBuilder	dateBuilder()	builder for date subtype
static DateSetFieldBuilder	dateSetBuilder()	builder for dateSet subtype
static DateTimeFieldBuilder	dateTimeBuilder()	builder for dateTime subtype
static DateTimeSetFieldBuilder	dateTimeSetBuilder()	builder for dateTimeSet subtype
static CustomField	deepCopy(CustomField template)	factory method to create a deep copy of CustomField
static EnumFieldBuilder	enumBuilder()	builder for enum subtype
static EnumSetFieldBuilder	enumSetBuilder()	builder for enumSet subtype
@NotNull String	getType()	The type of this field.
static LocalizedEnumFieldBuilder	localizedEnumBuilder()	builder for localizedEnum subtype
static LocalizedEnumSetFieldBuilder	localizedEnumSetBuilder()	builder for localizedEnumSet subtype
static LocalizedStringFieldBuilder	localizedStringBuilder()	builder for localizedString subtype
static LocalizedStringSetFieldBuilder	localizedStringSetBuilder()	builder for localizedStringSet subtype
static MoneyFieldBuilder	moneyBuilder()	builder for money subtype
static MoneySetFieldBuilder	moneySetBuilder()	builder for moneySet subtype
static NumberFieldBuilder	numberBuilder()	builder for number subtype
static NumberSetFieldBuilder	numberSetBuilder()	builder for numberSet subtype
static ReferenceFieldBuilder	referenceBuilder()	builder for reference subtype
static ReferenceSetFieldBuilder	referenceSetBuilder()	builder for referenceSet subtype
static StringFieldBuilder	stringBuilder()	builder for string subtype
static StringSetFieldBuilder	stringSetBuilder()	builder for stringSet subtype
static TimeFieldBuilder	timeBuilder()	builder for time subtype
static TimeSetFieldBuilder	timeSetBuilder()	builder for timeSet subtype
static com.fasterxml.jackson.core.type.TypeReference<CustomField>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomField(Function<CustomField,T> helper)	accessor map function

Method Details

getType

@NotNull
@NotNull String getType()

The type of this field.

Returns:

type

deepCopy

@Nullable
static CustomField deepCopy(@Nullable
 CustomField template)

factory method to create a deep copy of CustomField

Parameters:

template - instance to be copied

Returns:

copy instance

booleanBuilder

static BooleanFieldBuilder booleanBuilder()

builder for boolean subtype

Returns:

builder

booleanSetBuilder

static BooleanSetFieldBuilder booleanSetBuilder()

builder for booleanSet subtype

Returns:

builder

dateBuilder

static DateFieldBuilder dateBuilder()

builder for date subtype

Returns:

builder

dateSetBuilder

static DateSetFieldBuilder dateSetBuilder()

builder for dateSet subtype

Returns:

builder

dateTimeBuilder

static DateTimeFieldBuilder dateTimeBuilder()

builder for dateTime subtype

Returns:

builder

dateTimeSetBuilder

static DateTimeSetFieldBuilder dateTimeSetBuilder()

builder for dateTimeSet subtype

Returns:

builder

enumBuilder

static EnumFieldBuilder enumBuilder()

builder for enum subtype

Returns:

builder

enumSetBuilder

static EnumSetFieldBuilder enumSetBuilder()

builder for enumSet subtype

Returns:

builder

localizedEnumBuilder

static LocalizedEnumFieldBuilder localizedEnumBuilder()

builder for localizedEnum subtype

Returns:

builder

localizedEnumSetBuilder

static LocalizedEnumSetFieldBuilder localizedEnumSetBuilder()

builder for localizedEnumSet subtype

Returns:

builder

localizedStringBuilder

static LocalizedStringFieldBuilder localizedStringBuilder()

builder for localizedString subtype

Returns:

builder

localizedStringSetBuilder

static LocalizedStringSetFieldBuilder localizedStringSetBuilder()

builder for localizedStringSet subtype

Returns:

builder

moneyBuilder

static MoneyFieldBuilder moneyBuilder()

builder for money subtype

Returns:

builder

moneySetBuilder

static MoneySetFieldBuilder moneySetBuilder()

builder for moneySet subtype

Returns:

builder

numberBuilder

static NumberFieldBuilder numberBuilder()

builder for number subtype

Returns:

builder

numberSetBuilder

static NumberSetFieldBuilder numberSetBuilder()

builder for numberSet subtype

Returns:

builder

referenceBuilder

static ReferenceFieldBuilder referenceBuilder()

builder for reference subtype

Returns:

builder

referenceSetBuilder

static ReferenceSetFieldBuilder referenceSetBuilder()

builder for referenceSet subtype

Returns:

builder

stringBuilder

static StringFieldBuilder stringBuilder()

builder for string subtype

Returns:

builder

stringSetBuilder

static StringSetFieldBuilder stringSetBuilder()

builder for stringSet subtype

Returns:

builder

timeBuilder

static TimeFieldBuilder timeBuilder()

builder for time subtype

Returns:

builder

timeSetBuilder

static TimeSetFieldBuilder timeSetBuilder()

builder for timeSet subtype

Returns:

builder

withCustomField

default <T> T withCustomField(Function<CustomField,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<CustomField> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference