ZipCodeOfCountry (josef 3.2.5 API)

java.lang.Object
- java.lang.Enum<ZipCodeOfCountry>
- - org.josef.util.ZipCodeOfCountry

All Implemented Interfaces:

Serializable, Comparable<ZipCodeOfCountry>
```
@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2012-02-06")
public enum ZipCodeOfCountry
extends Enum<ZipCodeOfCountry>
```
Enumeration of zip codes, uses in different countries.
The enumerated constants can be used to verify whether a zip code is valid within a country. Additionally, this class uses Masks so zip codes can be formatted properly. For some countries a single mask is not enough. In this case multiple masks may be used concatenated with the pipe (|) symbol.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

See Also:

WikiPedia

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AFGHANISTAN` Afghanistan has 4 digits.
`ALBANIA` Albania has 4 digits.
`ALGERIA` Algeria has 5 digits.
`ARGENTINA` Argentina has (letter)(4 digits)(2 letters).
`AUSTRALIA` Australia has 4 digits.
`AUSTRIA` Austria has 4 digits.
`BELGIUM` Belgium has 4 digits.
`BRAZIL` Brazil has 8 digits.
`CANADA` Canada has (letter)(digit)(letter)(space)(digit)(letter)(digit).
`CHINA` China has 6 digits.
`FRANCE` France has 5 digits.
`GERMANY` Germany has 5 digits.
`GREECE` Greece has 5 digits.
`HUNGARY` Hungary has 4 digits.
`ICELAND` Iceland has 3 digits.
`INDONESIA` Indonesia has 5 digits.
`ISRAEL` Israel has 7 digits.
`ITALY` Italy has 5 digits.
`LUXEMBOURG` Luxembourg has 4 digits.
`NETHERLANDS` Netherlands has 4 digits and 2 letters.
`POLAND` Poland has 5 digits.
`PORTUGAL` Portugal has 7 digits.
`SPAIN` Spain has 5 digits.
`SWEDEN` Sweden has 5 digits.
`SWITZERLAND` Switzerland has 4 digits.
`UNITED_KINGDOM` United Kingdom has: (1 or 2 letters)(1 or 2 digits)(optional letter)(space)(1 digit)(2 letters).
`UNKNOWN_ZIP_CODE_OF_COUNTRY` Country with unknown zip code has 9 characters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`fromMaskedValue(String zipCode)` Removes mask characters from the supplied zipCode.
`String`	`fromUnmaskedValue(String zipCode)` Adds mask characters to the supplied zipCode.
`Iso3166Country`	`getCountry()` Gets the country where this zip code is used.
`String`	`getMask()` Gets the mask to display a zip code.
`int`	`getMaximumMaskLength()` Gets the length of the longest mask.
`Pattern`	`getPattern()` Gets the pattern to verify a zip code against.
`boolean`	`isValidZipCode(String zipCode)` Determines whether the supplied zipCode is valid with respect to this ZipCode.
`static ZipCodeOfCountry`	`valueOf(Iso3166Country country)` Gets the ZipCodeOfCountry corresponding to the supplied country.
`static ZipCodeOfCountry`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ZipCodeOfCountry[]`	`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
  - AFGHANISTAN
```
public static final ZipCodeOfCountry AFGHANISTAN
```
    Afghanistan has 4 digits.
  - ALBANIA
```
public static final ZipCodeOfCountry ALBANIA
```
    Albania has 4 digits.
  - ALGERIA
```
public static final ZipCodeOfCountry ALGERIA
```
    Algeria has 5 digits.
  - ARGENTINA
```
public static final ZipCodeOfCountry ARGENTINA
```
    Argentina has (letter)(4 digits)(2 letters).
  - AUSTRALIA
```
public static final ZipCodeOfCountry AUSTRALIA
```
    Australia has 4 digits.
  - AUSTRIA
```
public static final ZipCodeOfCountry AUSTRIA
```
    Austria has 4 digits.
  - BELGIUM
```
public static final ZipCodeOfCountry BELGIUM
```
    Belgium has 4 digits.
  - BRAZIL
```
public static final ZipCodeOfCountry BRAZIL
```
    Brazil has 8 digits.
  - CANADA
```
public static final ZipCodeOfCountry CANADA
```
    Canada has (letter)(digit)(letter)(space)(digit)(letter)(digit).
  - CHINA
```
public static final ZipCodeOfCountry CHINA
```
    China has 6 digits.
  - FRANCE
```
public static final ZipCodeOfCountry FRANCE
```
    France has 5 digits.
  - GERMANY
```
public static final ZipCodeOfCountry GERMANY
```
    Germany has 5 digits.
  - GREECE
```
public static final ZipCodeOfCountry GREECE
```
    Greece has 5 digits.
  - HUNGARY
```
public static final ZipCodeOfCountry HUNGARY
```
    Hungary has 4 digits.
  - ICELAND
```
public static final ZipCodeOfCountry ICELAND
```
    Iceland has 3 digits.
  - INDONESIA
```
public static final ZipCodeOfCountry INDONESIA
```
    Indonesia has 5 digits.
  - ISRAEL
```
public static final ZipCodeOfCountry ISRAEL
```
    Israel has 7 digits.
  - ITALY
```
public static final ZipCodeOfCountry ITALY
```
    Italy has 5 digits.
  - LUXEMBOURG
```
public static final ZipCodeOfCountry LUXEMBOURG
```
    Luxembourg has 4 digits.
  - NETHERLANDS
```
public static final ZipCodeOfCountry NETHERLANDS
```
    Netherlands has 4 digits and 2 letters.
    The letters may not spell: SA, SD or SS (due to the Germans).
  - POLAND
```
public static final ZipCodeOfCountry POLAND
```
    Poland has 5 digits.
  - PORTUGAL
```
public static final ZipCodeOfCountry PORTUGAL
```
    Portugal has 7 digits.
  - SPAIN
```
public static final ZipCodeOfCountry SPAIN
```
    Spain has 5 digits.
  - SWEDEN
```
public static final ZipCodeOfCountry SWEDEN
```
    Sweden has 5 digits.
  - SWITZERLAND
```
public static final ZipCodeOfCountry SWITZERLAND
```
    Switzerland has 4 digits.
  - UNITED_KINGDOM
```
public static final ZipCodeOfCountry UNITED_KINGDOM
```
    United Kingdom has: (1 or 2 letters)(1 or 2 digits)(optional letter)(space)(1 digit)(2 letters).
  - UNKNOWN_ZIP_CODE_OF_COUNTRY
```
public static final ZipCodeOfCountry UNKNOWN_ZIP_CODE_OF_COUNTRY
```
    Country with unknown zip code has 9 characters.
- Method Detail
  - values
```
public static ZipCodeOfCountry[] 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 (ZipCodeOfCountry c : ZipCodeOfCountry.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ZipCodeOfCountry 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
  - getCountry
```
public Iso3166Country getCountry()
```
    Gets the country where this zip code is used.
    
    Returns:
    
    The country where this zip code is used.
  - getPattern
```
public Pattern getPattern()
```
    Gets the pattern to verify a zip code against.
    
    Returns:
    
    The pattern to verify a zip code against.
  - getMask
```
public String getMask()
```
    Gets the mask to display a zip code.
    
    Returns:
    
    The mask to display a zip code.
    Note: The returned mask may consist of multiple masks, separated by a pipe (|) symbol.
  - getMaximumMaskLength
```
public int getMaximumMaskLength()
```
    Gets the length of the longest mask.
    
    Returns:
    
    The length of the longest mask.
  - isValidZipCode
```
public boolean isValidZipCode(String zipCode)
```
    Determines whether the supplied zipCode is valid with respect to this ZipCode.
    
    Parameters:
    
    zipCode - The zipCode to validate.
    
    Returns:
    
    True when the zipCode is valid, otherwise false is returned.
  - valueOf
```
public static ZipCodeOfCountry valueOf(Iso3166Country country)
```
    Gets the ZipCodeOfCountry corresponding to the supplied country.
    
    Parameters:
    
    country - The country.
    
    Returns:
    
    The ZipCodeOfCountry corresponding to the supplied country.
    When a country does use zip codes but this class does not support them yet, UNKNOWN_ZIP_CODE_OF_COUNTRY is returned, supporting up to 9 characters.
    
    Throws:
    
    NullPointerException - When the supplied country is null.
  - fromUnmaskedValue
```
public String fromUnmaskedValue(String zipCode)
```
    Adds mask characters to the supplied zipCode.
    
    Parameters:
    
    zipCode - The zip code to add the mask characters to.
    
    Returns:
    
    The supplied zipCode with the appropriate mask characters.
  - fromMaskedValue
```
public String fromMaskedValue(String zipCode)
```
    Removes mask characters from the supplied zipCode.
    
    Parameters:
    
    zipCode - The zip code to remove the mask characters from.
    
    Returns:
    
    The supplied zipCode without the mask characters.

Enum ZipCodeOfCountry

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AFGHANISTAN

ALBANIA

ALGERIA

ARGENTINA

AUSTRALIA

AUSTRIA

BELGIUM

BRAZIL

CANADA

CHINA

FRANCE

GERMANY

GREECE

HUNGARY

ICELAND

INDONESIA

ISRAEL

ITALY

LUXEMBOURG

NETHERLANDS

POLAND

PORTUGAL

SPAIN

SWEDEN

SWITZERLAND

UNITED_KINGDOM

UNKNOWN_ZIP_CODE_OF_COUNTRY

Method Detail

values

valueOf

getCountry

getPattern

getMask

getMaximumMaskLength

isValidZipCode

valueOf

fromUnmaskedValue

fromMaskedValue