org.jadira.cdt.phonenumber.api

Interface PhoneNumber

All Known Implementing Classes:

E164PhoneNumberWithExtension

public interface PhoneNumber

Applies to representations of phone numbers.

Method Summary

Modifier and Type	Method and Description
String	extractAreaCode() Splits the national number into its constituent parts, returning that part of the number that represents the area code.
CountryCode	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.
String	toE164NumberString() Returns the E164 formatted telephone number.
String	toE164NumberWithExtensionString() Returns the E164 formatted telephone number.

Method Detail

getCountryDiallingCode

String getCountryDiallingCode()

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

Returns:

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

getNationalNumber

String getNationalNumber()

Returns the national number part for the phone number.

Returns:

The country dialling code e.g. '1963350474'

getExtension

String getExtension()

Returns the extension for the phone number or null.

Returns:

The extension

toE164NumberString

String toE164NumberString()

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

Returns:

The telephone number formatted as E164.

toE164NumberWithExtensionString

String toE164NumberWithExtensionString()

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

Returns:

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

extractCountryCode

CountryCode extractCountryCode()

Returns the CountryCode this number belongs to

Returns:

The CountryCode

extractAreaCode

String extractAreaCode()

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

Returns:

The area code

extractSubscriberNumber

String extractSubscriberNumber()

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

Returns:

The subscriber number