Class GeoLocation
- All Implemented Interfaces:
Serializable
,Cloneable
A complex type that contains information about a geo location.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The code for a continent geo location.The code for a country geo location.The code for a country's subdivision (e.g., a province of Canada).int
hashCode()
void
setContinentCode
(String continentCode) The code for a continent geo location.void
setCountryCode
(String countryCode) The code for a country geo location.void
setSubdivisionCode
(String subdivisionCode) The code for a country's subdivision (e.g., a province of Canada).toString()
Returns a string representation of this object; useful for testing and debugging.withContinentCode
(String continentCode) The code for a continent geo location.withCountryCode
(String countryCode) The code for a country geo location.withSubdivisionCode
(String subdivisionCode) The code for a country's subdivision (e.g., a province of Canada).
-
Constructor Details
-
GeoLocation
public GeoLocation()
-
-
Method Details
-
setContinentCode
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values:
AF
|AN
|AS
|EU
|OC
|NA
|SA
Constraint: Specifying
ContinentCode
with eitherCountryCode
orSubdivisionCode
returns an InvalidInput error.- Parameters:
continentCode
- The code for a continent geo location. Note: only continent locations have a continent code.Valid values:
AF
|AN
|AS
|EU
|OC
|NA
|SA
Constraint: Specifying
ContinentCode
with eitherCountryCode
orSubdivisionCode
returns an InvalidInput error.
-
getContinentCode
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values:
AF
|AN
|AS
|EU
|OC
|NA
|SA
Constraint: Specifying
ContinentCode
with eitherCountryCode
orSubdivisionCode
returns an InvalidInput error.- Returns:
- The code for a continent geo location. Note: only continent
locations have a continent code.
Valid values:
AF
|AN
|AS
|EU
|OC
|NA
|SA
Constraint: Specifying
ContinentCode
with eitherCountryCode
orSubdivisionCode
returns an InvalidInput error.
-
withContinentCode
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values:
AF
|AN
|AS
|EU
|OC
|NA
|SA
Constraint: Specifying
ContinentCode
with eitherCountryCode
orSubdivisionCode
returns an InvalidInput error.- Parameters:
continentCode
- The code for a continent geo location. Note: only continent locations have a continent code.Valid values:
AF
|AN
|AS
|EU
|OC
|NA
|SA
Constraint: Specifying
ContinentCode
with eitherCountryCode
orSubdivisionCode
returns an InvalidInput error.- 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.
-
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.
Constraint: Specifying
SubdivisionCode
withoutCountryCode
returns an InvalidInput error.- 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.Constraint: Specifying
SubdivisionCode
withoutCountryCode
returns an InvalidInput error.
-
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.
Constraint: Specifying
SubdivisionCode
withoutCountryCode
returns an InvalidInput error.- 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.
Constraint: Specifying
SubdivisionCode
withoutCountryCode
returns an InvalidInput error.
-
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.
Constraint: Specifying
SubdivisionCode
withoutCountryCode
returns an InvalidInput error.- 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.Constraint: Specifying
SubdivisionCode
withoutCountryCode
returns an InvalidInput error.- 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
-