public class GeoLocationDetails
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
A complex type that contains information about a GeoLocation
.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
continentCode
The code for a continent geo location.
|
private java.lang.String |
continentName
The name of the continent.
|
private java.lang.String |
countryCode
The code for a country geo location.
|
private java.lang.String |
countryName
The name of the country.
|
private java.lang.String |
subdivisionCode
The code for a country's subdivision (e.g., a province of Canada).
|
private java.lang.String |
subdivisionName
The name of the subdivision.
|
Constructor and Description |
---|
GeoLocationDetails() |
Modifier and Type | Method and Description |
---|---|
GeoLocationDetails |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getContinentCode()
The code for a continent geo location.
|
java.lang.String |
getContinentName()
The name of the continent.
|
java.lang.String |
getCountryCode()
The code for a country geo location.
|
java.lang.String |
getCountryName()
The name of the country.
|
java.lang.String |
getSubdivisionCode()
The code for a country's subdivision (e.g., a province of Canada).
|
java.lang.String |
getSubdivisionName()
The name of the subdivision.
|
int |
hashCode() |
void |
setContinentCode(java.lang.String continentCode)
The code for a continent geo location.
|
void |
setContinentName(java.lang.String continentName)
The name of the continent.
|
void |
setCountryCode(java.lang.String countryCode)
The code for a country geo location.
|
void |
setCountryName(java.lang.String countryName)
The name of the country.
|
void |
setSubdivisionCode(java.lang.String subdivisionCode)
The code for a country's subdivision (e.g., a province of Canada).
|
void |
setSubdivisionName(java.lang.String subdivisionName)
The name of the subdivision.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GeoLocationDetails |
withContinentCode(java.lang.String continentCode)
The code for a continent geo location.
|
GeoLocationDetails |
withContinentName(java.lang.String continentName)
The name of the continent.
|
GeoLocationDetails |
withCountryCode(java.lang.String countryCode)
The code for a country geo location.
|
GeoLocationDetails |
withCountryName(java.lang.String countryName)
The name of the country.
|
GeoLocationDetails |
withSubdivisionCode(java.lang.String subdivisionCode)
The code for a country's subdivision (e.g., a province of Canada).
|
GeoLocationDetails |
withSubdivisionName(java.lang.String subdivisionName)
The name of the subdivision.
|
private java.lang.String continentCode
The code for a continent geo location. Note: only continent locations have a continent code.
private java.lang.String continentName
The name of the continent. This element is only present if
ContinentCode
is also present.
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 countryName
The name of the country. This element is only present if
CountryCode
is also present.
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.
private java.lang.String subdivisionName
The name of the subdivision. This element is only present if
SubdivisionCode
is also present.
public void setContinentCode(java.lang.String continentCode)
The code for a continent geo location. Note: only continent locations have a continent code.
continentCode
- The code for a continent geo location. Note: only continent
locations have a continent code.public java.lang.String getContinentCode()
The code for a continent geo location. Note: only continent locations have a continent code.
public GeoLocationDetails withContinentCode(java.lang.String continentCode)
The code for a continent geo location. Note: only continent locations have a continent code.
continentCode
- The code for a continent geo location. Note: only continent
locations have a continent code.public void setContinentName(java.lang.String continentName)
The name of the continent. This element is only present if
ContinentCode
is also present.
continentName
- The name of the continent. This element is only present if
ContinentCode
is also present.public java.lang.String getContinentName()
The name of the continent. This element is only present if
ContinentCode
is also present.
ContinentCode
is also present.public GeoLocationDetails withContinentName(java.lang.String continentName)
The name of the continent. This element is only present if
ContinentCode
is also present.
continentName
- The name of the continent. This element is only present if
ContinentCode
is also present.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 GeoLocationDetails 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 setCountryName(java.lang.String countryName)
The name of the country. This element is only present if
CountryCode
is also present.
countryName
- The name of the country. This element is only present if
CountryCode
is also present.public java.lang.String getCountryName()
The name of the country. This element is only present if
CountryCode
is also present.
CountryCode
is also present.public GeoLocationDetails withCountryName(java.lang.String countryName)
The name of the country. This element is only present if
CountryCode
is also present.
countryName
- The name of the country. This element is only present if
CountryCode
is also present.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.
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.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.
public GeoLocationDetails 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.
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.public void setSubdivisionName(java.lang.String subdivisionName)
The name of the subdivision. This element is only present if
SubdivisionCode
is also present.
subdivisionName
- The name of the subdivision. This element is only present if
SubdivisionCode
is also present.public java.lang.String getSubdivisionName()
The name of the subdivision. This element is only present if
SubdivisionCode
is also present.
SubdivisionCode
is also present.public GeoLocationDetails withSubdivisionName(java.lang.String subdivisionName)
The name of the subdivision. This element is only present if
SubdivisionCode
is also present.
subdivisionName
- The name of the subdivision. This element is only present if
SubdivisionCode
is also present.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 GeoLocationDetails clone()
clone
in class java.lang.Object