Class GeoLocationDetails
- All Implemented Interfaces:
Serializable
,Cloneable
A complex type that contains information about a GeoLocation
.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The code for a continent geo location.The name of the continent.The code for a country geo location.The name of the country.The code for a country's subdivision (e.g., a province of Canada).The name of the subdivision.int
hashCode()
void
setContinentCode
(String continentCode) The code for a continent geo location.void
setContinentName
(String continentName) The name of the continent.void
setCountryCode
(String countryCode) The code for a country geo location.void
setCountryName
(String countryName) The name of the country.void
setSubdivisionCode
(String subdivisionCode) The code for a country's subdivision (e.g., a province of Canada).void
setSubdivisionName
(String subdivisionName) The name of the subdivision.toString()
Returns a string representation of this object; useful for testing and debugging.withContinentCode
(String continentCode) The code for a continent geo location.withContinentName
(String continentName) The name of the continent.withCountryCode
(String countryCode) The code for a country geo location.withCountryName
(String countryName) The name of the country.withSubdivisionCode
(String subdivisionCode) The code for a country's subdivision (e.g., a province of Canada).withSubdivisionName
(String subdivisionName) The name of the subdivision.
-
Constructor Details
-
GeoLocationDetails
public GeoLocationDetails()
-
-
Method Details
-
setContinentCode
The code for a continent geo location. Note: only continent locations have a continent code.
- Parameters:
continentCode
- The code for a continent geo location. Note: only continent locations have a continent code.
-
getContinentCode
The code for a continent geo location. Note: only continent locations have a continent code.
- Returns:
- The code for a continent geo location. Note: only continent locations have a continent code.
-
withContinentCode
The code for a continent geo location. Note: only continent locations have a continent code.
- Parameters:
continentCode
- The code for a continent geo location. Note: only continent locations have a continent code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setContinentName
The name of the continent. This element is only present if
ContinentCode
is also present.- Parameters:
continentName
- The name of the continent. This element is only present ifContinentCode
is also present.
-
getContinentName
The name of the continent. This element is only present if
ContinentCode
is also present.- Returns:
- The name of the continent. This element is only present if
ContinentCode
is also present.
-
withContinentName
The name of the continent. This element is only present if
ContinentCode
is also present.- Parameters:
continentName
- The name of the continent. This element is only present ifContinentCode
is also present.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCountryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a
*
for the country code. All other country codes follow the ISO 3166 two-character code.- Parameters:
countryCode
- The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.The default geo location uses a
*
for the country code. All other country codes follow the ISO 3166 two-character code.
-
getCountryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a
*
for the country code. All other country codes follow the ISO 3166 two-character code.- Returns:
- The code for a country geo location. The default location uses
'*' for the country code and will match all locations that are
not matched by a geo location.
The default geo location uses a
*
for the country code. All other country codes follow the ISO 3166 two-character code.
-
withCountryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a
*
for the country code. All other country codes follow the ISO 3166 two-character code.- Parameters:
countryCode
- The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.The default geo location uses a
*
for the country code. All other country codes follow the ISO 3166 two-character code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCountryName
The name of the country. This element is only present if
CountryCode
is also present.- Parameters:
countryName
- The name of the country. This element is only present ifCountryCode
is also present.
-
getCountryName
The name of the country. This element is only present if
CountryCode
is also present.- Returns:
- The name of the country. This element is only present if
CountryCode
is also present.
-
withCountryName
The name of the country. This element is only present if
CountryCode
is also present.- Parameters:
countryName
- The name of the country. This element is only present ifCountryCode
is also present.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSubdivisionCode
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
- Parameters:
subdivisionCode
- The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
-
getSubdivisionCode
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
- Returns:
- The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
-
withSubdivisionCode
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
- Parameters:
subdivisionCode
- The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSubdivisionName
The name of the subdivision. This element is only present if
SubdivisionCode
is also present.- Parameters:
subdivisionName
- The name of the subdivision. This element is only present ifSubdivisionCode
is also present.
-
getSubdivisionName
The name of the subdivision. This element is only present if
SubdivisionCode
is also present.- Returns:
- The name of the subdivision. This element is only present if
SubdivisionCode
is also present.
-
withSubdivisionName
The name of the subdivision. This element is only present if
SubdivisionCode
is also present.- Parameters:
subdivisionName
- The name of the subdivision. This element is only present ifSubdivisionCode
is also present.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-