Package com.commercetools.history.models.common

Interface Address

public interface Address
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()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique ID of the Address.

      Returns:
      id

    • getKey

      @NotNull @NotNull String getKey()
      Returns:
      key

    • getTitle

      @NotNull @NotNull String getTitle()
      Returns:
      title

    • getSalutation

      @NotNull @NotNull String getSalutation()
      Returns:
      salutation

    • getFirstName

      @NotNull @NotNull String getFirstName()
      Returns:
      firstName

    • getLastName

      @NotNull @NotNull String getLastName()
      Returns:
      lastName

    • getStreetName

      @NotNull @NotNull String getStreetName()
      Returns:
      streetName

    • getStreetNumber

      @NotNull @NotNull String getStreetNumber()
      Returns:
      streetNumber

    • getAdditionalStreetInfo

      @NotNull @NotNull String getAdditionalStreetInfo()
      Returns:
      additionalStreetInfo

    • getPostalCode

      @NotNull @NotNull String getPostalCode()
      Returns:
      postalCode

    • getCity

      @NotNull @NotNull String getCity()
      Returns:
      city

    • getRegion

      @NotNull @NotNull String getRegion()
      Returns:
      region

    • getState

      @NotNull @NotNull String getState()
      Returns:
      state

    • getCountry

      @NotNull @NotNull String getCountry()

      Two-digit country code as per ISO 3166-1 alpha-2.

      Returns:
      country

    • getCompany

      @NotNull @NotNull String getCompany()
      Returns:
      company

    • getDepartment

      @NotNull @NotNull String getDepartment()
      Returns:
      department

    • getBuilding

      @NotNull @NotNull String getBuilding()
      Returns:
      building

    • getApartment

      @NotNull @NotNull String getApartment()
      Returns:
      apartment

    • getPOBox

      @NotNull @NotNull String getPOBox()
      Returns:
      pOBox

    • getPhone

      @NotNull @NotNull String getPhone()
      Returns:
      phone

    • getMobile

      @NotNull @NotNull String getMobile()
      Returns:
      mobile

    • getEmail

      @NotNull @NotNull String getEmail()
      Returns:
      email

    • getFax

      @NotNull @NotNull String getFax()
      Returns:
      fax

    • getAdditionalAddressInfo

      @NotNull @NotNull String getAdditionalAddressInfo()
      Returns:
      additionalAddressInfo

    • getExternalId

      @NotNull @NotNull String getExternalId()
      Returns:
      externalId

    • setId

      void setId(String id)

      Unique ID of the Address.

      Parameters:
      id - value to be set

    • setKey

      void setKey(String key)
      set key
      Parameters:
      key - value to be set

    • setTitle

      void setTitle(String title)
      set title
      Parameters:
      title - value to be set

    • setSalutation

      void setSalutation(String salutation)
      set salutation
      Parameters:
      salutation - value to be set

    • setFirstName

      void setFirstName(String firstName)
      set firstName
      Parameters:
      firstName - value to be set

    • setLastName

      void setLastName(String lastName)
      set lastName
      Parameters:
      lastName - value to be set

    • setStreetName

      void setStreetName(String streetName)
      set streetName
      Parameters:
      streetName - value to be set

    • setStreetNumber

      void setStreetNumber(String streetNumber)
      set streetNumber
      Parameters:
      streetNumber - value to be set

    • setAdditionalStreetInfo

      void setAdditionalStreetInfo(String additionalStreetInfo)
      set additionalStreetInfo
      Parameters:
      additionalStreetInfo - value to be set

    • setPostalCode

      void setPostalCode(String postalCode)
      set postalCode
      Parameters:
      postalCode - value to be set

    • setCity

      void setCity(String city)
      set city
      Parameters:
      city - value to be set

    • setRegion

      void setRegion(String region)
      set region
      Parameters:
      region - value to be set

    • setState

      void setState(String state)
      set state
      Parameters:
      state - value to be set

    • setCountry

      void setCountry(String country)

      Two-digit country code as per ISO 3166-1 alpha-2.

      Parameters:
      country - value to be set

    • setCompany

      void setCompany(String company)
      set company
      Parameters:
      company - value to be set

    • setDepartment

      void setDepartment(String department)
      set department
      Parameters:
      department - value to be set

    • setBuilding

      void setBuilding(String building)
      set building
      Parameters:
      building - value to be set

    • setApartment

      void setApartment(String apartment)
      set apartment
      Parameters:
      apartment - value to be set

    • setPOBox

      void setPOBox(String pOBox)
      set pOBox
      Parameters:
      pOBox - value to be set

    • setPhone

      void setPhone(String phone)
      set phone
      Parameters:
      phone - value to be set

    • setMobile

      void setMobile(String mobile)
      set mobile
      Parameters:
      mobile - value to be set

    • setEmail

      void setEmail(String email)
      set email
      Parameters:
      email - value to be set

    • setFax

      void setFax(String fax)
      set fax
      Parameters:
      fax - value to be set

    • setAdditionalAddressInfo

      void setAdditionalAddressInfo(String additionalAddressInfo)
      set additionalAddressInfo
      Parameters:
      additionalAddressInfo - value to be set

    • setExternalId

      void setExternalId(String externalId)
      set externalId
      Parameters:
      externalId - 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()

    • 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