Interface Address.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Address.Builder,Address>, SdkBuilder<Address.Builder,Address>, SdkPojo
Enclosing class:
Address
@Mutable @NotThreadSafe public static interface Address.Builder extends SdkPojo, CopyableBuilder<Address.Builder,Address>

  • Method Details

    • label

      Address.Builder label(String label)

      Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.

      Parameters:
      label - Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • country

      Address.Builder country(Country country)

      The country component of the address.

      Parameters:
      country - The country component of the address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • country

      default Address.Builder country(Consumer<Country.Builder> country)

      The country component of the address.

      This is a convenience method that creates an instance of the Country.Builder avoiding the need to create one manually via Country.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to country(Country).

      Parameters:
      country - a consumer that will call methods on Country.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • region

      Address.Builder region(Region region)

      The region or state results should be present in.

      Example: North Rhine-Westphalia.

      Parameters:
      region - The region or state results should be present in.

      Example: North Rhine-Westphalia.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      default Address.Builder region(Consumer<Region.Builder> region)

      The region or state results should be present in.

      Example: North Rhine-Westphalia.

      This is a convenience method that creates an instance of the Region.Builder avoiding the need to create one manually via Region.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to region(Region).

      Parameters:
      region - a consumer that will call methods on Region.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subRegion

      Address.Builder subRegion(SubRegion subRegion)

      The sub-region or county for which results should be present in.

      Parameters:
      subRegion - The sub-region or county for which results should be present in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subRegion

      default Address.Builder subRegion(Consumer<SubRegion.Builder> subRegion)

      The sub-region or county for which results should be present in.

      This is a convenience method that creates an instance of the SubRegion.Builder avoiding the need to create one manually via SubRegion.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to subRegion(SubRegion).

      Parameters:
      subRegion - a consumer that will call methods on SubRegion.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • locality

      Address.Builder locality(String locality)

      The city or locality of the address.

      Example: Vancouver.

      Parameters:
      locality - The city or locality of the address.

      Example: Vancouver.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • district

      Address.Builder district(String district)

      The district or division of a locality associated with this address.

      Parameters:
      district - The district or division of a locality associated with this address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subDistrict

      Address.Builder subDistrict(String subDistrict)

      A subdivision of a district.

      Example: Minden-Lübbecke.

      Parameters:
      subDistrict - A subdivision of a district.

      Example: Minden-Lübbecke.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • postalCode

      Address.Builder postalCode(String postalCode)

      An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.

      Parameters:
      postalCode - An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • block

      Address.Builder block(String block)

      Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

      Parameters:
      block - Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subBlock

      Address.Builder subBlock(String subBlock)

      Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

      Parameters:
      subBlock - Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intersection

      Address.Builder intersection(Collection<String> intersection)

      Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

      Parameters:
      intersection - Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intersection

      Address.Builder intersection(String... intersection)

      Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

      Parameters:
      intersection - Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • street

      Address.Builder street(String street)

      The name of the street results should be present in.

      Parameters:
      street - The name of the street results should be present in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streetComponents

      Address.Builder streetComponents(Collection<StreetComponents> streetComponents)

      Components of the street.

      Example: Younge from the "Younge street".

      Parameters:
      streetComponents - Components of the street.

      Example: Younge from the "Younge street".

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streetComponents

      Address.Builder streetComponents(StreetComponents... streetComponents)

      Components of the street.

      Example: Younge from the "Younge street".

      Parameters:
      streetComponents - Components of the street.

      Example: Younge from the "Younge street".

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streetComponents

      Address.Builder streetComponents(Consumer<StreetComponents.Builder>... streetComponents)

      Components of the street.

      Example: Younge from the "Younge street".

      This is a convenience method that creates an instance of the StreetComponents.Builder avoiding the need to create one manually via StreetComponents.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streetComponents(List<StreetComponents>).

      Parameters:
      streetComponents - a consumer that will call methods on StreetComponents.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addressNumber

      Address.Builder addressNumber(String addressNumber)

      The number that identifies an address within a street.

      Parameters:
      addressNumber - The number that identifies an address within a street.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • building

      Address.Builder building(String building)

      The name of the building at the address.

      Parameters:
      building - The name of the building at the address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddressComponents

      Address.Builder secondaryAddressComponents(Collection<SecondaryAddressComponent> secondaryAddressComponents)

      Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.

      Parameters:
      secondaryAddressComponents - Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddressComponents

      Address.Builder secondaryAddressComponents(SecondaryAddressComponent... secondaryAddressComponents)

      Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.

      Parameters:
      secondaryAddressComponents - Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddressComponents

      Address.Builder secondaryAddressComponents(Consumer<SecondaryAddressComponent.Builder>... secondaryAddressComponents)

      Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.

      This is a convenience method that creates an instance of the SecondaryAddressComponent.Builder avoiding the need to create one manually via SecondaryAddressComponent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secondaryAddressComponents(List<SecondaryAddressComponent>).

      Parameters:
      secondaryAddressComponents - a consumer that will call methods on SecondaryAddressComponent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: