com.commercetools.history.models.common.Address Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercetools-sdk-java-history Show documentation
Show all versions of commercetools-sdk-java-history Show documentation
The e-commerce SDK from commercetools Composable Commerce for Java
package com.commercetools.history.models.common;
import java.time.*;
import java.util.*;
import java.util.function.Function;
import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;
import io.vrap.rmf.base.client.utils.Generated;
/**
* Address
*
*
* Example to create an instance using the builder pattern
*
*
* Address address = Address.builder()
* .id("{id}")
* .key("{key}")
* .title("{title}")
* .salutation("{salutation}")
* .firstName("{firstName}")
* .lastName("{lastName}")
* .streetName("{streetName}")
* .streetNumber("{streetNumber}")
* .additionalStreetInfo("{additionalStreetInfo}")
* .postalCode("{postalCode}")
* .city("{city}")
* .region("{region}")
* .state("{state}")
* .country("{country}")
* .company("{company}")
* .department("{department}")
* .building("{building}")
* .apartment("{apartment}")
* .pOBox("{pOBox}")
* .phone("{phone}")
* .mobile("{mobile}")
* .email("{email}")
* .fax("{fax}")
* .additionalAddressInfo("{additionalAddressInfo}")
* .externalId("{externalId}")
* .build()
*
*
*/
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = AddressImpl.class)
public interface Address {
/**
* Unique ID of the Address.
* @return id
*/
@NotNull
@JsonProperty("id")
public String getId();
/**
*
* @return key
*/
@NotNull
@JsonProperty("key")
public String getKey();
/**
*
* @return title
*/
@NotNull
@JsonProperty("title")
public String getTitle();
/**
*
* @return salutation
*/
@NotNull
@JsonProperty("salutation")
public String getSalutation();
/**
*
* @return firstName
*/
@NotNull
@JsonProperty("firstName")
public String getFirstName();
/**
*
* @return lastName
*/
@NotNull
@JsonProperty("lastName")
public String getLastName();
/**
*
* @return streetName
*/
@NotNull
@JsonProperty("streetName")
public String getStreetName();
/**
*
* @return streetNumber
*/
@NotNull
@JsonProperty("streetNumber")
public String getStreetNumber();
/**
*
* @return additionalStreetInfo
*/
@NotNull
@JsonProperty("additionalStreetInfo")
public String getAdditionalStreetInfo();
/**
*
* @return postalCode
*/
@NotNull
@JsonProperty("postalCode")
public String getPostalCode();
/**
*
* @return city
*/
@NotNull
@JsonProperty("city")
public String getCity();
/**
*
* @return region
*/
@NotNull
@JsonProperty("region")
public String getRegion();
/**
*
* @return state
*/
@NotNull
@JsonProperty("state")
public String getState();
/**
* Two-digit country code as per ISO 3166-1 alpha-2.
* @return country
*/
@NotNull
@JsonProperty("country")
public String getCountry();
/**
*
* @return company
*/
@NotNull
@JsonProperty("company")
public String getCompany();
/**
*
* @return department
*/
@NotNull
@JsonProperty("department")
public String getDepartment();
/**
*
* @return building
*/
@NotNull
@JsonProperty("building")
public String getBuilding();
/**
*
* @return apartment
*/
@NotNull
@JsonProperty("apartment")
public String getApartment();
/**
*
* @return pOBox
*/
@NotNull
@JsonProperty("pOBox")
public String getPOBox();
/**
*
* @return phone
*/
@NotNull
@JsonProperty("phone")
public String getPhone();
/**
*
* @return mobile
*/
@NotNull
@JsonProperty("mobile")
public String getMobile();
/**
*
* @return email
*/
@NotNull
@JsonProperty("email")
public String getEmail();
/**
*
* @return fax
*/
@NotNull
@JsonProperty("fax")
public String getFax();
/**
*
* @return additionalAddressInfo
*/
@NotNull
@JsonProperty("additionalAddressInfo")
public String getAdditionalAddressInfo();
/**
*
* @return externalId
*/
@NotNull
@JsonProperty("externalId")
public String getExternalId();
/**
* Unique ID of the Address.
* @param id value to be set
*/
public void setId(final String id);
/**
* set key
* @param key value to be set
*/
public void setKey(final String key);
/**
* set title
* @param title value to be set
*/
public void setTitle(final String title);
/**
* set salutation
* @param salutation value to be set
*/
public void setSalutation(final String salutation);
/**
* set firstName
* @param firstName value to be set
*/
public void setFirstName(final String firstName);
/**
* set lastName
* @param lastName value to be set
*/
public void setLastName(final String lastName);
/**
* set streetName
* @param streetName value to be set
*/
public void setStreetName(final String streetName);
/**
* set streetNumber
* @param streetNumber value to be set
*/
public void setStreetNumber(final String streetNumber);
/**
* set additionalStreetInfo
* @param additionalStreetInfo value to be set
*/
public void setAdditionalStreetInfo(final String additionalStreetInfo);
/**
* set postalCode
* @param postalCode value to be set
*/
public void setPostalCode(final String postalCode);
/**
* set city
* @param city value to be set
*/
public void setCity(final String city);
/**
* set region
* @param region value to be set
*/
public void setRegion(final String region);
/**
* set state
* @param state value to be set
*/
public void setState(final String state);
/**
* Two-digit country code as per ISO 3166-1 alpha-2.
* @param country value to be set
*/
public void setCountry(final String country);
/**
* set company
* @param company value to be set
*/
public void setCompany(final String company);
/**
* set department
* @param department value to be set
*/
public void setDepartment(final String department);
/**
* set building
* @param building value to be set
*/
public void setBuilding(final String building);
/**
* set apartment
* @param apartment value to be set
*/
public void setApartment(final String apartment);
/**
* set pOBox
* @param pOBox value to be set
*/
public void setPOBox(final String pOBox);
/**
* set phone
* @param phone value to be set
*/
public void setPhone(final String phone);
/**
* set mobile
* @param mobile value to be set
*/
public void setMobile(final String mobile);
/**
* set email
* @param email value to be set
*/
public void setEmail(final String email);
/**
* set fax
* @param fax value to be set
*/
public void setFax(final String fax);
/**
* set additionalAddressInfo
* @param additionalAddressInfo value to be set
*/
public void setAdditionalAddressInfo(final String additionalAddressInfo);
/**
* set externalId
* @param externalId value to be set
*/
public void setExternalId(final String externalId);
/**
* factory method
* @return instance of Address
*/
public static Address of() {
return new AddressImpl();
}
/**
* factory method to create a shallow copy Address
* @param template instance to be copied
* @return copy instance
*/
public static Address of(final Address template) {
AddressImpl instance = new AddressImpl();
instance.setId(template.getId());
instance.setKey(template.getKey());
instance.setTitle(template.getTitle());
instance.setSalutation(template.getSalutation());
instance.setFirstName(template.getFirstName());
instance.setLastName(template.getLastName());
instance.setStreetName(template.getStreetName());
instance.setStreetNumber(template.getStreetNumber());
instance.setAdditionalStreetInfo(template.getAdditionalStreetInfo());
instance.setPostalCode(template.getPostalCode());
instance.setCity(template.getCity());
instance.setRegion(template.getRegion());
instance.setState(template.getState());
instance.setCountry(template.getCountry());
instance.setCompany(template.getCompany());
instance.setDepartment(template.getDepartment());
instance.setBuilding(template.getBuilding());
instance.setApartment(template.getApartment());
instance.setPOBox(template.getPOBox());
instance.setPhone(template.getPhone());
instance.setMobile(template.getMobile());
instance.setEmail(template.getEmail());
instance.setFax(template.getFax());
instance.setAdditionalAddressInfo(template.getAdditionalAddressInfo());
instance.setExternalId(template.getExternalId());
return instance;
}
/**
* factory method to create a deep copy of Address
* @param template instance to be copied
* @return copy instance
*/
@Nullable
public static Address deepCopy(@Nullable final Address template) {
if (template == null) {
return null;
}
AddressImpl instance = new AddressImpl();
instance.setId(template.getId());
instance.setKey(template.getKey());
instance.setTitle(template.getTitle());
instance.setSalutation(template.getSalutation());
instance.setFirstName(template.getFirstName());
instance.setLastName(template.getLastName());
instance.setStreetName(template.getStreetName());
instance.setStreetNumber(template.getStreetNumber());
instance.setAdditionalStreetInfo(template.getAdditionalStreetInfo());
instance.setPostalCode(template.getPostalCode());
instance.setCity(template.getCity());
instance.setRegion(template.getRegion());
instance.setState(template.getState());
instance.setCountry(template.getCountry());
instance.setCompany(template.getCompany());
instance.setDepartment(template.getDepartment());
instance.setBuilding(template.getBuilding());
instance.setApartment(template.getApartment());
instance.setPOBox(template.getPOBox());
instance.setPhone(template.getPhone());
instance.setMobile(template.getMobile());
instance.setEmail(template.getEmail());
instance.setFax(template.getFax());
instance.setAdditionalAddressInfo(template.getAdditionalAddressInfo());
instance.setExternalId(template.getExternalId());
return instance;
}
/**
* builder factory method for Address
* @return builder
*/
public static AddressBuilder builder() {
return AddressBuilder.of();
}
/**
* create builder for Address instance
* @param template instance with prefilled values for the builder
* @return builder
*/
public static AddressBuilder builder(final Address template) {
return AddressBuilder.of(template);
}
/**
* accessor map function
* @param mapped type
* @param helper function to map the object
* @return mapped value
*/
default T withAddress(Function helper) {
return helper.apply(this);
}
/**
* gives a TypeReference for usage with Jackson DataBind
* @return TypeReference
*/
public static com.fasterxml.jackson.core.type.TypeReference typeReference() {
return new com.fasterxml.jackson.core.type.TypeReference() {
@Override
public String toString() {
return "TypeReference";
}
};
}
}