Package com.commercetools.api.models.common

Interface Address

All Superinterfaces:

BaseAddress, BaseAddressMixin, Customizable<Address>, WithKey

public interface Address
extends BaseAddress, Customizable<Address>

Address type returned by read methods. Optionally, the custom field can be present in addition to the fields of a BaseAddress.

Example to create an instance using the builder pattern

     Address address = Address.builder()
             .country("{country}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static AddressBuilder	builder()	builder factory method for Address
static AddressBuilder	builder(Address template)	create builder for Address instance
Address	copyDeep()
static Address	deepCopy(Address template)	factory method to create a deep copy of Address
@Valid CustomFields	getCustom()	Custom Fields defined for the Address.
String	getId()	Unique identifier of the Address.
static Address	of()	factory method
static Address	of(Address template)	factory method to create a shallow copy Address
void	setCustom(CustomFields custom)	Custom Fields defined for the Address.
void	setId(String id)	set id
static com.fasterxml.jackson.core.type.TypeReference<Address>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAddress(Function<Address,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseAddress

getAdditionalAddressInfo, getAdditionalStreetInfo, getApartment, getBuilding, getCity, getCompany, getCountry, getDepartment, getEmail, getExternalId, getFax, getFirstName, getKey, getLastName, getMobile, getPhone, getPOBox, getPostalCode, getRegion, getSalutation, getState, getStreetName, getStreetNumber, getTitle, setAdditionalAddressInfo, setAdditionalStreetInfo, setApartment, setBuilding, setCity, setCompany, setCountry, setDepartment, setEmail, setExternalId, setFax, setFirstName, setKey, setLastName, setMobile, setPhone, setPOBox, setPostalCode, setRegion, setSalutation, setState, setStreetName, setStreetNumber, setTitle, withBaseAddress

Methods inherited from interface com.commercetools.api.models.common.BaseAddressMixin

equalsIgnoreId, toDraft, toDraftBuilder

Methods inherited from interface com.commercetools.api.models.Customizable

unwrapCustomizable

Method Details

getCustom

@Valid
@Valid CustomFields getCustom()

Custom Fields defined for the Address.

Specified by:

getCustom in interface Customizable<Address>

Returns:

custom

getId

String getId()

Description copied from interface: BaseAddress

Unique identifier of the Address.

It is not recommended to set it manually since the API overwrites this ID when creating an Address for a Customer. Use key instead and omit this field from the request to let the API generate the ID for the Address.

Specified by:

getId in interface BaseAddress

Returns:

id

setCustom

void setCustom(CustomFields custom)

Custom Fields defined for the Address.

Specified by:

setCustom in interface Customizable<Address>

Parameters:

custom - value to be set

setId

void setId(String id)

set id

Specified by:

setId in interface BaseAddress

Parameters:

id - value to be set

of

static Address of()

factory method

Returns:

instance of Address

of

static Address of(Address template)

factory method to create a shallow copy Address

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

Address copyDeep()

Specified by:

copyDeep in interface BaseAddress

deepCopy

@Nullable
static Address deepCopy(@Nullable
 Address template)

factory method to create a deep copy of Address

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AddressBuilder builder()

builder factory method for Address

Returns:

builder

builder

static AddressBuilder builder(Address template)

create builder for Address instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAddress

default <T> T withAddress(Function<Address,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<Address> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference