Interface Address.Builder

    • Method Detail

      • 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.
      • 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.
      • 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.
      • locality

        Address.Builder locality​(String locality)

        The locality or city of the address.

        Example: Vancouver.

        Parameters:
        locality - The locality or city 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 posses.

        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 posses.
        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.
      • 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.