AdditionalFieldKeys (geocodingservices - geocoding-api 5.1.796 API)

java.lang.Object
- java.lang.Enum<AdditionalFieldKeys>
- - com.mapinfo.geocode.AdditionalFieldKeys

All Implemented Interfaces:

Serializable, Comparable<AdditionalFieldKeys>
```
public enum AdditionalFieldKeys
extends Enum<AdditionalFieldKeys>
```
This class defines keys used in Candidate's custom fields and supported by many countries. A country may also have custom keys beyond those listed here; see the country's capability information to see any additional keys that may be returned

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AREA_NAME_1` Used to represent the largest geographic division in an area, such as a state, province, or region
`AREA_NAME_2` Used to represent the secondary geographic division in an area, such as a county or district.
`AREA_NAME_3` Used to represent the city or town name
`AREA_NAME_4` Represents the smallest common geographic division in an area, such as a city subdivision or locality
`MAIN_ADDRESS` Represents the name of the street
`POST_ADDRESS` Contains any additional information that may appear after the street name
`POST_CODE_1` Represents the main postal code.
`POST_CODE_2` Represents the secondary postal code, if used.
`POST_DIRECTIONAL` Contains the type when it appears before the street name, e.g., "Main St SW"
`POST_THOROUGHFARE_TYPE` Contains the type when it appears after the street name, e.g., "Main St"
`PRE_ADDRESS` Contains any additional information that may appear before the base street name
`PRE_DIRECTIONAL` Contains the type when it appears before the street name, e.g., "West Main St"
`PRE_THOROUGHFARE_TYPE` Contains the type when it appears before the street name, e.g., "Via Veneto"

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AdditionalFieldKeys`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AdditionalFieldKeys[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AREA_NAME_1
```
public static final AdditionalFieldKeys AREA_NAME_1
```
    Used to represent the largest geographic division in an area, such as a state, province, or region
  - AREA_NAME_2
```
public static final AdditionalFieldKeys AREA_NAME_2
```
    Used to represent the secondary geographic division in an area, such as a county or district.
  - AREA_NAME_3
```
public static final AdditionalFieldKeys AREA_NAME_3
```
    Used to represent the city or town name
  - AREA_NAME_4
```
public static final AdditionalFieldKeys AREA_NAME_4
```
    Represents the smallest common geographic division in an area, such as a city subdivision or locality
  - POST_CODE_1
```
public static final AdditionalFieldKeys POST_CODE_1
```
    Represents the main postal code.
  - POST_CODE_2
```
public static final AdditionalFieldKeys POST_CODE_2
```
    Represents the secondary postal code, if used. An example of a secondary postal code is the optional "plus 4" 4 digit extension to the USA 5 digit main postal code.
  - MAIN_ADDRESS
```
public static final AdditionalFieldKeys MAIN_ADDRESS
```
    Represents the name of the street
  - PRE_ADDRESS
```
public static final AdditionalFieldKeys PRE_ADDRESS
```
    Contains any additional information that may appear before the base street name
  - POST_ADDRESS
```
public static final AdditionalFieldKeys POST_ADDRESS
```
    Contains any additional information that may appear after the street name
  - PRE_THOROUGHFARE_TYPE
```
public static final AdditionalFieldKeys PRE_THOROUGHFARE_TYPE
```
    Contains the type when it appears before the street name, e.g., "Via Veneto"
  - POST_THOROUGHFARE_TYPE
```
public static final AdditionalFieldKeys POST_THOROUGHFARE_TYPE
```
    Contains the type when it appears after the street name, e.g., "Main St"
  - PRE_DIRECTIONAL
```
public static final AdditionalFieldKeys PRE_DIRECTIONAL
```
    Contains the type when it appears before the street name, e.g., "West Main St"
  - POST_DIRECTIONAL
```
public static final AdditionalFieldKeys POST_DIRECTIONAL
```
    Contains the type when it appears before the street name, e.g., "Main St SW"
- Method Detail
  - values
```
public static AdditionalFieldKeys[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AdditionalFieldKeys c : AdditionalFieldKeys.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AdditionalFieldKeys valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum AdditionalFieldKeys

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AREA_NAME_1

AREA_NAME_2

AREA_NAME_3

AREA_NAME_4

POST_CODE_1

POST_CODE_2

MAIN_ADDRESS

PRE_ADDRESS

POST_ADDRESS

PRE_THOROUGHFARE_TYPE

POST_THOROUGHFARE_TYPE

PRE_DIRECTIONAL

POST_DIRECTIONAL

Method Detail

values

valueOf