Package com.marcosavard.commons.geog.ca

Class PostalCode

java.lang.Object

com.marcosavard.commons.geog.ca.PostalCode

All Implemented Interfaces:

java.io.Serializable

public class PostalCode
extends java.lang.Object
implements java.io.Serializable

A class to store Canadian postal code, with formatting and validating methods.

Author:

Marco

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PostalCode.Region

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VALID_LETTERS

Constructor Summary

Constructors

Constructor	Description
PostalCode(java.lang.String postalCode)

Method Summary

Modifier and Type	Method	Description
int	compareTo(PostalCode postalCode)
CanadianProvince	getProvince()
PostalCode.Region	getRegion()
boolean	isRural()
boolean	isValid()
java.lang.String	toDisplayString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALID_LETTERS

public static final java.lang.String VALID_LETTERS

See Also:

Constant Field Values

Constructor Detail

PostalCode

public PostalCode(java.lang.String postalCode)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDisplayString

public java.lang.String toDisplayString()

compareTo

public int compareTo(PostalCode postalCode)

isRural

public boolean isRural()

isValid

public boolean isValid()

getProvince

public CanadianProvince getProvince()

getRegion

public PostalCode.Region getRegion()