Package com.marcosavard.commons.geog.ca

Enum CanadianProvince

java.lang.Object

java.lang.Enum<CanadianProvince>

com.marcosavard.commons.geog.ca.CanadianProvince

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CanadianProvince>

public enum CanadianProvince
extends java.lang.Enum<CanadianProvince>

An enumeration for Canadian provinces and territories. Codes follow naming convention of Canada Post.

Author:

Marco

Enum Constant Summary

Enum Constants

Enum Constant	Description
AB
BC
MB
NB
NL
NS
NT
NU
ON
PE
QC
SK
YK

Method Summary

Modifier and Type	Method	Description
java.lang.String	getEnglishName()
java.lang.String	getFrenchName()
static CanadianProvince	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CanadianProvince[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NL

public static final CanadianProvince NL

NS

public static final CanadianProvince NS

PE

public static final CanadianProvince PE

NB

public static final CanadianProvince NB

QC

public static final CanadianProvince QC

ON

public static final CanadianProvince ON

MB

public static final CanadianProvince MB

SK

public static final CanadianProvince SK

AB

public static final CanadianProvince AB

BC

public static final CanadianProvince BC

NU

public static final CanadianProvince NU

NT

public static final CanadianProvince NT

YK

public static final CanadianProvince YK

Method Detail

values

public static CanadianProvince[] 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 (CanadianProvince c : CanadianProvince.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CanadianProvince valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getEnglishName

public java.lang.String getEnglishName()

getFrenchName

public java.lang.String getFrenchName()