com.revolsys.ui.html.domain

Class PhoneNumber

java.lang.Object

com.revolsys.ui.html.domain.PhoneNumber

public final class PhoneNumber
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static String	format(String phoneNumber) Format the phone number using the format for the default country.
static String	format(String phoneNumber, Country country) Format the phone number using the National format specification defined for the Country.
static String	format(String phoneNumber, Country country, boolean international) Format the phone number using the specification defined for the Country.
static String	format(String phoneNumber, Locale locale) Format the phone number using the National format specification defined for the Locale.
static String	format(String phoneNumber, String regex, String format) Parse a phone number using the regular expression and if it matches the phone number, format it using the specified format otherwise return null.
static boolean	isValid(String phoneNumber)
static String	normalize(String phoneNumber) Normalize the phone number removing any non-digit characters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

format

public static String format(String phoneNumber)

Format the phone number using the format for the default country. If the phone number does not match the specification for that country the first few digits of the phone number will be used to lookup a matching country and formatted using that country, if that fails the unformatted phone number will be returned.

Parameters:

phoneNumber - The normalized phone number to format.

Returns:

The formatted phone number.

format

public static String format(String phoneNumber,
            Country country)

Format the phone number using the National format specification defined for the Country. If the phone number does not match the specification for that country the first few digits of the phone number will be used to lookup a matching country and formatted using that country, if that fails the unformatted phone number will be returned.

Parameters:

phoneNumber - The normalized phone number to format.

country - The Country the phone number should be formatted for.

Returns:

The formatted phone number.

format

public static String format(String phoneNumber,
            Country country,
            boolean international)

Format the phone number using the specification defined for the Country. If the international parameter is set to true then use the International phone number format with the country code prefix, otherwise use the National phone number format. If the phone number does not match the specification for that country the first few digits of the phone number will be used to lookup a matching country and formatted using that country's international format, if that fails the unformatted phone number will be returned.

Parameters:

phoneNumber - The normalized phone number to format.

country - The Country the phone number should be formatted for.

international - True if the phone number should use the international format.

Returns:

The formatted phone number.

format

public static String format(String phoneNumber,
            Locale locale)

Format the phone number using the National format specification defined for the Locale. If the phone number does not match the specification for that locale the first few digits of the phone number will be used to lookup a matching country and formatted using that locale, if that fails the unformatted phone number will be returned.

Parameters:

phoneNumber - The normalized phone number to format.

locale - The Locale the phone number should be formatted for.

Returns:

The formatted phone number.

format

public static String format(String phoneNumber,
            String regex,
            String format)

Parse a phone number using the regular expression and if it matches the phone number, format it using the specified format otherwise return null.

Parameters:

phoneNumber - The normalized phone number to format.

regex - The regular expression to match phone numbers.

format - The format specification.

Returns:

The formatted phone number.

isValid

public static boolean isValid(String phoneNumber)

normalize

public static String normalize(String phoneNumber)

Normalize the phone number removing any non-digit characters.

Parameters:

phoneNumber - The phone number.

Returns:

The normalized phone number.