test3

Class PhoneNumber

java.lang.Object

test3.PhoneNumber

All Implemented Interfaces:

Comparable<PhoneNumber>

public final class PhoneNumber
extends Object
implements Comparable<PhoneNumber>

A class that represents North American phone numbers. Every phone number has 10 digits where the first 3 digits are the area code, the next three digits are the exchange code, and the last four digits are the station code.

The class ensures that there is only one PhoneNumber instance for each unique phone number. Clients should use the getInstance method to obtain a PhoneNumber instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(PhoneNumber other) Compares two phone numbers for order.
boolean	equals(Object obj) Compares two phone numbers for equality.
short	getAreaCode() Returns the area code.
short	getExchangeCode() Returns the exchange code.
static PhoneNumber	getInstance(int areaCode, int exchangeCode, int stationCode) Get a phone number having the given area code, exchange code, and station code.
short	getStationCode() Returns the station code.
int	hashCode() Returns a hash code for this phone number.
String	toString() Returns a string representation of this phone number.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static PhoneNumber getInstance(int areaCode,
                                      int exchangeCode,
                                      int stationCode)

Get a phone number having the given area code, exchange code, and station code.

Parameters:

areaCode - the area code; must be in the range 0-999

exchangeCode - the exchange code; must be in the range 0-999

stationCode - the station code; must be in the range 0-9999

Returns:

a phone number with the given area, exchange, and station codes

Throws:

IllegalArgumentException - if any of the area code, exchange code or station code are out of range

getAreaCode

public short getAreaCode()

Returns the area code.

Returns:

the area code

getExchangeCode

public short getExchangeCode()

Returns the exchange code.

Returns:

the exchange code

getStationCode

public short getStationCode()

Returns the station code.

Returns:

the station code

toString

public String toString()

Returns a string representation of this phone number. An example of a string representation of a phone number is "(416) 736-2100"

Overrides:

toString in class Object

Returns:

a string representation of this phone number

hashCode

public int hashCode()

Returns a hash code for this phone number.

Overrides:

hashCode in class Object

Returns:

a hash code for this phone number

equals

public boolean equals(Object obj)

Compares two phone numbers for equality. The result is true if and only if the argument is not null and is an PhoneNumber object that has the same area, exchange, and station code as this phone number.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this phone number against

Returns:

true if the given object represents an PhoneNumber equivalent to this phone number, false otherwise

compareTo

public int compareTo(PhoneNumber other)

Compares two phone numbers for order. The phone numbers are compared first by area code, then by exchange code, then by station code.

Specified by:

compareTo in interface Comparable<PhoneNumber>

Parameters:

other - the phone number to be compared

Returns:

a negative integer if this phone number is less than the other phone number, 0 if this phone number is equal to the other phone number, or a positive integer if this phone number is greater than the other phone number