Interface Address.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Address.Builder,Address>,SdkBuilder<Address.Builder,Address>,SdkPojo
- Enclosing class:
- Address
public static interface Address.Builder extends SdkPojo, CopyableBuilder<Address.Builder,Address>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Address.BuilderaddressNumber(String addressNumber)The number that identifies an address within a street.Address.Builderblock(String block)Name of the block.Address.Builderbuilding(String building)The name of the building at the address.default Address.Buildercountry(Consumer<Country.Builder> country)The country component of the address.Address.Buildercountry(Country country)The country component of the address.Address.Builderdistrict(String district)The district or division of a locality associated with this address.Address.Builderintersection(String... intersection)Name of the streets in the intersection.Address.Builderintersection(Collection<String> intersection)Name of the streets in the intersection.Address.Builderlabel(String label)Assembled address value built out of the address components, according to the regional postal rules.Address.Builderlocality(String locality)The locality or city of the address.Address.BuilderpostalCode(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.default Address.Builderregion(Consumer<Region.Builder> region)The region or state results should be present in.Address.Builderregion(Region region)The region or state results should be present in.Address.Builderstreet(String street)The name of the street results should be present in.Address.BuilderstreetComponents(Collection<StreetComponents> streetComponents)Components of the street.Address.BuilderstreetComponents(Consumer<StreetComponents.Builder>... streetComponents)Components of the street.Address.BuilderstreetComponents(StreetComponents... streetComponents)Components of the street.Address.BuildersubBlock(String subBlock)Name of sub-block.Address.BuildersubDistrict(String subDistrict)A subdivision of a district.default Address.BuildersubRegion(Consumer<SubRegion.Builder> subRegion)The sub-region or county for which results should be present in.Address.BuildersubRegion(SubRegion subRegion)The sub-region or county for which results should be present in.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
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.
-
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 theCountry.Builderavoiding the need to create one manually viaCountry.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocountry(Country).- Parameters:
country- a consumer that will call methods onCountry.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
country(Country)
-
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:
This is a convenience method that creates an instance of theNorth Rhine-Westphalia.Region.Builderavoiding the need to create one manually viaRegion.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toregion(Region).- Parameters:
region- a consumer that will call methods onRegion.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
region(Region)
-
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 theSubRegion.Builderavoiding the need to create one manually viaSubRegion.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosubRegion(SubRegion).- Parameters:
subRegion- a consumer that will call methods onSubRegion.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
subRegion(SubRegion)
-
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.
-
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 theStreetComponents.Builderavoiding the need to create one manually viaStreetComponents.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#streetComponents(List.) - Parameters:
streetComponents- a consumer that will call methods onStreetComponents.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#streetComponents(java.util.Collection)
-
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.
-
-