org.jadira.cdt.phonenumber.impl

Class E164PhoneNumberWithExtension

java.lang.Object

org.jadira.cdt.phonenumber.impl.E164PhoneNumberWithExtension

All Implemented Interfaces:

Serializable, PhoneNumber

public class E164PhoneNumberWithExtension
extends Object
implements PhoneNumber, Serializable

This class represents a phone number with a broadly canonical rendering. The default form is to use E164 format with the addition of an optional extension. Extension is signified with a suffix of ";ext=". The class uses Google's excellent libphonenumber for its underlying representation. This gives it great flexibility in accomodating existing legacy number formats and converting them to a standardised notation. The class does not expose directly the wrapped PhoneNumber instance as it is immutable. However, it is possible to retrieve a copy for further manipulation.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	E164PhoneNumberWithExtension(com.google.i18n.phonenumbers.Phonenumber.PhoneNumber prototype) Creates a instance from the given PhoneNumber
protected	E164PhoneNumberWithExtension(String e164PhoneNumberWithExtension) Creates a new E164 Phone Number with the given extension.
protected	E164PhoneNumberWithExtension(String phoneNumber, CountryCode defaultCountryCode) Creates a new E164 Phone Number.
protected	E164PhoneNumberWithExtension(String e164PhoneNumber, String extension) Creates a new E164 Phone Number with the given extension.
protected	E164PhoneNumberWithExtension(String phoneNumber, String extension, CountryCode defaultCountryCode) Creates a new E164 Phone Number with the given extension.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	extractAreaCode() Splits the national number into its constituent parts, returning that part of the number that represents the area code.
ISOCountryCode	extractCountryCode() Returns the CountryCode this number belongs to
String	extractSubscriberNumber() Splits the national number into its constituent parts, returning that part of the number that represents the subscriber number.
String	getCountryDiallingCode() Returns the dialling code for the country that this phone number belongs to.
String	getExtension() Returns the extension for the phone number or null.
String	getNationalNumber() Returns the national number part for the phone number.
com.google.i18n.phonenumbers.Phonenumber.PhoneNumber	getUnderlyingPhoneNumber() Returns the underlying LibPhoneNumber Phonenumber.PhoneNumber instance.
int	hashCode()
static E164PhoneNumberWithExtension	ofE164PhoneNumberString(String e164PhoneNumber) Creates a new E164 Phone Number.
static E164PhoneNumberWithExtension	ofE164PhoneNumberStringAndExtension(String e164PhoneNumber, String extension) Creates a new E164 Phone Number with the given extension.
static E164PhoneNumberWithExtension	ofE164PhoneNumberWithExtensionString(String e164PhoneNumber) Creates a new E164 Phone Number with the given extension.
static E164PhoneNumberWithExtension	ofPhoneNumberString(String phoneNumber, CountryCode defaultCountryCode) Creates a new E164 Phone Number.
static E164PhoneNumberWithExtension	ofPhoneNumberStringAndExtension(String phoneNumber, String extension, CountryCode defaultCountryCode) Creates a new E164 Phone Number with the given extension.
String	toE164NumberString() Returns the E164 formatted telephone number.
String	toE164NumberWithExtensionString() Returns the E164 formatted telephone number.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

E164PhoneNumberWithExtension

public E164PhoneNumberWithExtension(com.google.i18n.phonenumbers.Phonenumber.PhoneNumber prototype)

Creates a instance from the given PhoneNumber

Parameters:

prototype - The PhoneNumber to construct the instance from

E164PhoneNumberWithExtension

protected E164PhoneNumberWithExtension(String e164PhoneNumberWithExtension)

Creates a new E164 Phone Number with the given extension.

Parameters:

e164PhoneNumberWithExtension - The phone number in E164 format. The extension may be appended. Any extension is appended to the number with the extension prefix given as ';ext='

E164PhoneNumberWithExtension

protected E164PhoneNumberWithExtension(String e164PhoneNumber,
                                       String extension)

Creates a new E164 Phone Number with the given extension.

Parameters:

e164PhoneNumber - The phone number in E164 format

extension - The extension, or null for no extension

E164PhoneNumberWithExtension

protected E164PhoneNumberWithExtension(String phoneNumber,
                                       CountryCode defaultCountryCode)

Creates a new E164 Phone Number.

Parameters:

phoneNumber - The phone number in arbitrary parseable format (may be a national format)

defaultCountryCode - The Country to apply if no country is indicated by the phone number

E164PhoneNumberWithExtension

protected E164PhoneNumberWithExtension(String phoneNumber,
                                       String extension,
                                       CountryCode defaultCountryCode)

Creates a new E164 Phone Number with the given extension.

Parameters:

phoneNumber - The phone number in arbitrary parseable format (may be a national format)

extension - The extension, or null for no extension

defaultCountryCode - The Country to apply if no country is indicated by the phone number

Method Detail

ofE164PhoneNumberString

public static E164PhoneNumberWithExtension ofE164PhoneNumberString(String e164PhoneNumber)

Creates a new E164 Phone Number.

Parameters:

e164PhoneNumber - The phone number in E164 format.

Returns:

A new instance of E164PhoneNumberWithExtension

ofE164PhoneNumberWithExtensionString

public static E164PhoneNumberWithExtension ofE164PhoneNumberWithExtensionString(String e164PhoneNumber)

Creates a new E164 Phone Number with the given extension.

Parameters:

e164PhoneNumber - The phone number in E164 format. The extension may be appended. Any extension is appended to the number with the extension prefix given as ';ext='

Returns:

A new instance of E164PhoneNumberWithExtension

ofE164PhoneNumberStringAndExtension

public static E164PhoneNumberWithExtension ofE164PhoneNumberStringAndExtension(String e164PhoneNumber,
                                                                               String extension)

Creates a new E164 Phone Number with the given extension.

Parameters:

e164PhoneNumber - The phone number in E164 format

extension - The extension, or null for no extension

Returns:

A new instance of E164PhoneNumberWithExtension

ofPhoneNumberString

public static E164PhoneNumberWithExtension ofPhoneNumberString(String phoneNumber,
                                                               CountryCode defaultCountryCode)

Creates a new E164 Phone Number.

Parameters:

phoneNumber - The phone number in arbitrary parseable format (may be a national format)

defaultCountryCode - The Country to apply if no country is indicated by the phone number

Returns:

A new instance of E164PhoneNumberWithExtension

ofPhoneNumberStringAndExtension

public static E164PhoneNumberWithExtension ofPhoneNumberStringAndExtension(String phoneNumber,
                                                                           String extension,
                                                                           CountryCode defaultCountryCode)

Creates a new E164 Phone Number with the given extension.

Parameters:

phoneNumber - The phone number in arbitrary parseable format (may be a national format)

extension - The extension, or null for no extension

defaultCountryCode - The Country to apply if no country is indicated by the phone number

Returns:

A new instance of E164PhoneNumberWithExtension

getUnderlyingPhoneNumber

public com.google.i18n.phonenumbers.Phonenumber.PhoneNumber getUnderlyingPhoneNumber()

Returns the underlying LibPhoneNumber Phonenumber.PhoneNumber instance. To preserve the immutability of E164PhoneNumber, a copy is made.

Returns:

The underlying PhoneNumber instance

extractCountryCode

public ISOCountryCode extractCountryCode()

Returns the CountryCode this number belongs to

Specified by:

extractCountryCode in interface PhoneNumber

Returns:

The CountryCode

getCountryDiallingCode

public String getCountryDiallingCode()

Returns the dialling code for the country that this phone number belongs to.

Specified by:

getCountryDiallingCode in interface PhoneNumber

Returns:

The country dialling code e.g. '+44'

getNationalNumber

public String getNationalNumber()

Returns the national number part for the phone number.

Specified by:

getNationalNumber in interface PhoneNumber

Returns:

The country dialling code e.g. '1963350474'

getExtension

public String getExtension()

Returns the extension for the phone number or null.

Specified by:

getExtension in interface PhoneNumber

Returns:

The extension

toE164NumberString

public String toE164NumberString()

Returns the E164 formatted telephone number. Any extension is ommitted.

Specified by:

toE164NumberString in interface PhoneNumber

Returns:

The telephone number formatted as E164.

toE164NumberWithExtensionString

public String toE164NumberWithExtensionString()

Returns the E164 formatted telephone number. Any extension is appended to the number with the extension prefix given as ';ext='

Specified by:

toE164NumberWithExtensionString in interface PhoneNumber

Returns:

The telephone number formatted as E164 together with the extension, if any.

extractAreaCode

public String extractAreaCode()

Splits the national number into its constituent parts, returning that part of the number that represents the area code.

Specified by:

extractAreaCode in interface PhoneNumber

Returns:

The area code

extractSubscriberNumber

public String extractSubscriberNumber()

Splits the national number into its constituent parts, returning that part of the number that represents the subscriber number.

Specified by:

extractSubscriberNumber in interface PhoneNumber

Returns:

The subscriber number

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object