Package com.marcosavard.commons.geog

Class PhoneNumber

java.lang.Object

com.marcosavard.commons.geog.PhoneNumber

All Implemented Interfaces:

java.io.Serializable

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

A class to store a North American phone number, with formatting and validating methods

Author:

Marco

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhoneNumber.Format

Constructor Summary

Constructors

Constructor	Description
PhoneNumber(java.lang.String fullNumber)	Create a phone number with no extension.
PhoneNumber(java.lang.String fullNumber, java.lang.String extension)	Create a phone number with an extension.

Method Summary

Modifier and Type	Method	Description
int	compareTo(PhoneNumber thatPhoneNumber)	Compare this phone number with that phone number.
java.lang.String	getAreaCode()
java.lang.String	getExtension()
java.lang.String	getNumber()
java.lang.String	getNumberEnd()
java.lang.String	getNumberStart()
static java.lang.String	getProbableAreaCodeFor(PostalCode postalCode)	Get a probable area code for a given postal code.
static PhoneNumber	parse(java.lang.String text)
static PhoneNumber	random(java.lang.String areaCode)
java.lang.String	toDisplayString()
java.lang.String	toDisplayString(java.lang.String pattern)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneNumber

public PhoneNumber(java.lang.String fullNumber)

Create a phone number with no extension.

Parameters:

fullNumber - number with area code

PhoneNumber

public PhoneNumber(java.lang.String fullNumber,
                   java.lang.String extension)

Create a phone number with an extension.

Parameters:

fullNumber - number with area code

Method Detail

getAreaCode

public java.lang.String getAreaCode()

getNumber

public java.lang.String getNumber()

getExtension

public java.lang.String getExtension()

getNumberStart

public java.lang.String getNumberStart()

getNumberEnd

public java.lang.String getNumberEnd()

parse

public static PhoneNumber parse(java.lang.String text)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDisplayString

public java.lang.String toDisplayString()

toDisplayString

public java.lang.String toDisplayString(java.lang.String pattern)

compareTo

public int compareTo(PhoneNumber thatPhoneNumber)

Compare this phone number with that phone number.

Parameters:

thatPhoneNumber - that phone number

Returns:

comparison

getProbableAreaCodeFor

public static java.lang.String getProbableAreaCodeFor(PostalCode postalCode)

Get a probable area code for a given postal code. Useful for error detection or to create realistic test cases.

Parameters:

postalCode - postal code

Returns:

area code

random

public static PhoneNumber random(java.lang.String areaCode)