Package com.commercetools.api.models.common

Class BaseAddressBuilder

java.lang.Object

com.commercetools.api.models.common.BaseAddressBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<BaseAddress>

public class BaseAddressBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<BaseAddress>

BaseAddressBuilder Example to create an instance using the builder pattern

     BaseAddress baseAddress = BaseAddress.builder()
             .country("{country}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
BaseAddressBuilder()

Method Summary

Modifier and Type	Method	Description
BaseAddressBuilder	additionalAddressInfo(String additionalAddressInfo)	Further information on the Address.
BaseAddressBuilder	additionalStreetInfo(String additionalStreetInfo)	Further information on the street address.
BaseAddressBuilder	apartment(String apartment)	Number or name of the apartment.
BaseAddress	build()	builds BaseAddress with checking for non-null required values
BaseAddressBuilder	building(String building)	Number or name of the building.
BaseAddress	buildUnchecked()	builds BaseAddress without checking for non-null required values
BaseAddressBuilder	city(String city)	Name of the city.
BaseAddressBuilder	company(String company)	Name of the company.
BaseAddressBuilder	country(String country)	Name of the country.
BaseAddressBuilder	department(String department)	Name of the department.
BaseAddressBuilder	email(String email)	Email address of the contact.
BaseAddressBuilder	externalId(String externalId)	ID for the contact used in an external system.
BaseAddressBuilder	fax(String fax)	Fax number of the contact.
BaseAddressBuilder	firstName(String firstName)	Given name (first name) of the contact.
String	getAdditionalAddressInfo()	Further information on the Address.
String	getAdditionalStreetInfo()	Further information on the street address.
String	getApartment()	Number or name of the apartment.
String	getBuilding()	Number or name of the building.
String	getCity()	Name of the city.
String	getCompany()	Name of the company.
String	getCountry()	Name of the country.
String	getDepartment()	Name of the department.
String	getEmail()	Email address of the contact.
String	getExternalId()	ID for the contact used in an external system.
String	getFax()	Fax number of the contact.
String	getFirstName()	Given name (first name) of the contact.
String	getId()	Unique identifier of the Address.
String	getKey()	User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
String	getLastName()	Family name (last name) of the contact.
String	getMobile()	Mobile phone number of the contact.
String	getPhone()	Phone number of the contact.
String	getPOBox()	Post office box number.
String	getPostalCode()	Postal code.
String	getRegion()	Name of the region.
String	getSalutation()	Salutation of the contact, for example 'Mr.' or 'Ms.'
String	getState()	Name of the state, for example, Colorado.
String	getStreetName()	Name of the street.
String	getStreetNumber()	Street number.
String	getTitle()	Title of the contact, for example 'Dr.'
BaseAddressBuilder	id(String id)	Unique identifier of the Address.
BaseAddressBuilder	key(String key)	User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
BaseAddressBuilder	lastName(String lastName)	Family name (last name) of the contact.
BaseAddressBuilder	mobile(String mobile)	Mobile phone number of the contact.
static BaseAddressBuilder	of()	factory method for an instance of BaseAddressBuilder
static BaseAddressBuilder	of(BaseAddress template)	create builder for BaseAddress instance
BaseAddressBuilder	phone(String phone)	Phone number of the contact.
BaseAddressBuilder	pOBox(String pOBox)	Post office box number.
BaseAddressBuilder	postalCode(String postalCode)	Postal code.
BaseAddressBuilder	region(String region)	Name of the region.
BaseAddressBuilder	salutation(String salutation)	Salutation of the contact, for example 'Mr.' or 'Ms.'
BaseAddressBuilder	state(String state)	Name of the state, for example, Colorado.
BaseAddressBuilder	streetName(String streetName)	Name of the street.
BaseAddressBuilder	streetNumber(String streetNumber)	Street number.
BaseAddressBuilder	title(String title)	Title of the contact, for example 'Dr.'

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BaseAddressBuilder

public BaseAddressBuilder()

Method Details

id

public BaseAddressBuilder id(@Nullable
 String id)

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.

Parameters:

id - value to be set

Returns:

Builder

key

public BaseAddressBuilder key(@Nullable
 String key)

User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.

Parameters:

key - value to be set

Returns:

Builder

country

public BaseAddressBuilder country(String country)

Name of the country.

Parameters:

country - value to be set

Returns:

Builder

title

public BaseAddressBuilder title(@Nullable
 String title)

Title of the contact, for example 'Dr.'

Parameters:

title - value to be set

Returns:

Builder

salutation

public BaseAddressBuilder salutation(@Nullable
 String salutation)

Salutation of the contact, for example 'Mr.' or 'Ms.'

Parameters:

salutation - value to be set

Returns:

Builder

firstName

public BaseAddressBuilder firstName(@Nullable
 String firstName)

Given name (first name) of the contact.

Parameters:

firstName - value to be set

Returns:

Builder

lastName

public BaseAddressBuilder lastName(@Nullable
 String lastName)

Family name (last name) of the contact.

Parameters:

lastName - value to be set

Returns:

Builder

streetName

public BaseAddressBuilder streetName(@Nullable
 String streetName)

Name of the street.

Parameters:

streetName - value to be set

Returns:

Builder

streetNumber

public BaseAddressBuilder streetNumber(@Nullable
 String streetNumber)

Street number.

Parameters:

streetNumber - value to be set

Returns:

Builder

additionalStreetInfo

public BaseAddressBuilder additionalStreetInfo(@Nullable
 String additionalStreetInfo)

Further information on the street address.

Parameters:

additionalStreetInfo - value to be set

Returns:

Builder

postalCode

public BaseAddressBuilder postalCode(@Nullable
 String postalCode)

Postal code.

Parameters:

postalCode - value to be set

Returns:

Builder

city

public BaseAddressBuilder city(@Nullable
 String city)

Name of the city.

Parameters:

city - value to be set

Returns:

Builder

region

public BaseAddressBuilder region(@Nullable
 String region)

Name of the region.

Parameters:

region - value to be set

Returns:

Builder

state

public BaseAddressBuilder state(@Nullable
 String state)

Name of the state, for example, Colorado.

Parameters:

state - value to be set

Returns:

Builder

company

public BaseAddressBuilder company(@Nullable
 String company)

Name of the company.

Parameters:

company - value to be set

Returns:

Builder

department

public BaseAddressBuilder department(@Nullable
 String department)

Name of the department.

Parameters:

department - value to be set

Returns:

Builder

building

public BaseAddressBuilder building(@Nullable
 String building)

Number or name of the building.

Parameters:

building - value to be set

Returns:

Builder

apartment

public BaseAddressBuilder apartment(@Nullable
 String apartment)

Number or name of the apartment.

Parameters:

apartment - value to be set

Returns:

Builder

pOBox

public BaseAddressBuilder pOBox(@Nullable
 String pOBox)

Post office box number.

Parameters:

pOBox - value to be set

Returns:

Builder

phone

public BaseAddressBuilder phone(@Nullable
 String phone)

Phone number of the contact.

Parameters:

phone - value to be set

Returns:

Builder

mobile

public BaseAddressBuilder mobile(@Nullable
 String mobile)

Mobile phone number of the contact.

Parameters:

mobile - value to be set

Returns:

Builder

email

public BaseAddressBuilder email(@Nullable
 String email)

Email address of the contact.

Parameters:

email - value to be set

Returns:

Builder

fax

public BaseAddressBuilder fax(@Nullable
 String fax)

Fax number of the contact.

Parameters:

fax - value to be set

Returns:

Builder

additionalAddressInfo

public BaseAddressBuilder additionalAddressInfo(@Nullable
 String additionalAddressInfo)

Further information on the Address.

Parameters:

additionalAddressInfo - value to be set

Returns:

Builder

externalId

public BaseAddressBuilder externalId(@Nullable
 String externalId)

ID for the contact used in an external system.

Parameters:

externalId - value to be set

Returns:

Builder

getId

@Nullable
public String getId()

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.

Returns:

id

getKey

@Nullable
public String getKey()

User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.

Returns:

key

getCountry

public String getCountry()

Name of the country.

Returns:

country

getTitle

@Nullable
public String getTitle()

Title of the contact, for example 'Dr.'

Returns:

title

getSalutation

@Nullable
public String getSalutation()

Salutation of the contact, for example 'Mr.' or 'Ms.'

Returns:

salutation

getFirstName

@Nullable
public String getFirstName()

Given name (first name) of the contact.

Returns:

firstName

getLastName

@Nullable
public String getLastName()

Family name (last name) of the contact.

Returns:

lastName

getStreetName

@Nullable
public String getStreetName()

Name of the street.

Returns:

streetName

getStreetNumber

@Nullable
public String getStreetNumber()

Street number.

Returns:

streetNumber

getAdditionalStreetInfo

@Nullable
public String getAdditionalStreetInfo()

Further information on the street address.

Returns:

additionalStreetInfo

getPostalCode

@Nullable
public String getPostalCode()

Postal code.

Returns:

postalCode

getCity

@Nullable
public String getCity()

Name of the city.

Returns:

city

getRegion

@Nullable
public String getRegion()

Name of the region.

Returns:

region

getState

@Nullable
public String getState()

Name of the state, for example, Colorado.

Returns:

state

getCompany

@Nullable
public String getCompany()

Name of the company.

Returns:

company

getDepartment

@Nullable
public String getDepartment()

Name of the department.

Returns:

department

getBuilding

@Nullable
public String getBuilding()

Number or name of the building.

Returns:

building

getApartment

@Nullable
public String getApartment()

Number or name of the apartment.

Returns:

apartment

getPOBox

@Nullable
public String getPOBox()

Post office box number.

Returns:

pOBox

getPhone

@Nullable
public String getPhone()

Phone number of the contact.

Returns:

phone

getMobile

@Nullable
public String getMobile()

Mobile phone number of the contact.

Returns:

mobile

getEmail

@Nullable
public String getEmail()

Email address of the contact.

Returns:

email

getFax

@Nullable
public String getFax()

Fax number of the contact.

Returns:

fax

getAdditionalAddressInfo

@Nullable
public String getAdditionalAddressInfo()

Further information on the Address.

Returns:

additionalAddressInfo

getExternalId

@Nullable
public String getExternalId()

ID for the contact used in an external system.

Returns:

externalId

build

public BaseAddress build()

builds BaseAddress with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<BaseAddress>

Returns:

BaseAddress

buildUnchecked

public BaseAddress buildUnchecked()

builds BaseAddress without checking for non-null required values

Returns:

BaseAddress

of

public static BaseAddressBuilder of()

factory method for an instance of BaseAddressBuilder

Returns:

builder

of

public static BaseAddressBuilder of(BaseAddress template)

create builder for BaseAddress instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder