com.luciad.format.gdf

Graph and Routing EngineClass TLcdGDFCountry

java.lang.Object

com.luciad.format.gdf.TLcdGDFCountry

public class TLcdGDFCountry
extends Object

Represents a country, with its ISO 3166 Country Code and a textual description. The list of available countries is based on the ISO 3166 Country Code list, as described in the GDF 4 specification..

Since:

5.1

Method Summary

Modifier and Type	Method and Description
static TLcdGDFCountry	getCountry(int aIndex) Returns the country at the given index.
static TLcdGDFCountry	getCountry(String aCountryCode) Returns the country with the given ISO 3166 Country Code.
static int	getCountryCount() Returns the number of countries that are available.
String	getDescription() Returns the textual description of this country.
String	getISO3166CountryCode() Returns the ISO 3166 Country Code of this country.
String	toString() Returns a general description of this country.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCountryCount

public static int getCountryCount()

Returns the number of countries that are available.

Returns:

the number of countries that are available.

getCountry

public static TLcdGDFCountry getCountry(int aIndex)

Returns the country at the given index.

Parameters:

aIndex - the index of the country to be returned.

Returns:

the country at the given index.

Throws:

IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getCountryCount().

getCountry

public static TLcdGDFCountry getCountry(String aCountryCode)

Returns the country with the given ISO 3166 Country Code.

Parameters:

aCountryCode - the ISO 3166 Country Code of the country to be returned.

Returns:

the country with the given ISO 3166 Country Code.

Throws:

IllegalArgumentException - if no language exists for the given ISO 3166 Country Code.

getISO3166CountryCode

public String getISO3166CountryCode()

Returns the ISO 3166 Country Code of this country.

Returns:

the ISO 3166 Country Code of this country.

getDescription

public String getDescription()

Returns the textual description of this country.

Returns:

the textual description of this country.

toString

public String toString()

Returns a general description of this country. The exact details of the representation are unspecified and are subject to change.

Overrides:

toString in class Object

Returns:

a general description of this country.