public class GeoLocation
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
A complex type that contains information about a geo location.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
continentCode
The code for a continent geo location.
|
private java.lang.String |
countryCode
The code for a country geo location.
|
private java.lang.String |
subdivisionCode
The code for a country's subdivision (e.g., a province of Canada).
|
Constructor and Description |
---|
GeoLocation() |
Modifier and Type | Method and Description |
---|---|
GeoLocation |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getContinentCode()
The code for a continent geo location.
|
java.lang.String |
getCountryCode()
The code for a country geo location.
|
java.lang.String |
getSubdivisionCode()
The code for a country's subdivision (e.g., a province of Canada).
|
int |
hashCode() |
void |
setContinentCode(java.lang.String continentCode)
The code for a continent geo location.
|
void |
setCountryCode(java.lang.String countryCode)
The code for a country geo location.
|
void |
setSubdivisionCode(java.lang.String subdivisionCode)
The code for a country's subdivision (e.g., a province of Canada).
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GeoLocation |
withContinentCode(java.lang.String continentCode)
The code for a continent geo location.
|
GeoLocation |
withCountryCode(java.lang.String countryCode)
The code for a country geo location.
|
GeoLocation |
withSubdivisionCode(java.lang.String subdivisionCode)
The code for a country's subdivision (e.g., a province of Canada).
|
private java.lang.String 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 either
CountryCode
or SubdivisionCode
returns an
InvalidInput error.
private java.lang.String 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.
private java.lang.String 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
without
CountryCode
returns an InvalidInput error.
public void setContinentCode(java.lang.String 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 either
CountryCode
or SubdivisionCode
returns an
InvalidInput error.
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 either
CountryCode
or SubdivisionCode
returns
an InvalidInput error.
public java.lang.String 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 either
CountryCode
or SubdivisionCode
returns an
InvalidInput error.
Valid values: AF
| AN
| AS
| EU
| OC
| NA
|
SA
Constraint: Specifying ContinentCode
with either
CountryCode
or SubdivisionCode
returns
an InvalidInput error.
public GeoLocation withContinentCode(java.lang.String 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 either
CountryCode
or SubdivisionCode
returns an
InvalidInput error.
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 either
CountryCode
or SubdivisionCode
returns
an InvalidInput error.
public void setCountryCode(java.lang.String 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.
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.
public java.lang.String 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.
The default geo location uses a *
for the country
code. All other country codes follow the ISO 3166 two-character
code.
public GeoLocation withCountryCode(java.lang.String 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.
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.
public void setSubdivisionCode(java.lang.String 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
without
CountryCode
returns an InvalidInput error.
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
without
CountryCode
returns an InvalidInput error.
public java.lang.String 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
without
CountryCode
returns an InvalidInput error.
Constraint: Specifying SubdivisionCode
without
CountryCode
returns an InvalidInput error.
public GeoLocation withSubdivisionCode(java.lang.String 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
without
CountryCode
returns an InvalidInput error.
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
without
CountryCode
returns an InvalidInput error.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public GeoLocation clone()
clone
in class java.lang.Object