}
/**
- * Returns a text description for the given phone number, in the language provided. The
- * description consists of the name of the carrier the number was originally allocated to, however
- * if the country supports mobile number portability the number might not belong to the returned
- * carrier anymore. If no mapping is found an empty string is returned.
+ * Returns a carrier name for the given phone number, in the language provided. The carrier name
+ * is the one the number was originally allocated to, however if the country supports mobile
+ * number portability the number might not belong to the returned carrier anymore. If no mapping
+ * is found an empty string is returned.
*
* <p>This method assumes the validity of the number passed in has already been checked, and that
* the number is suitable for carrier lookup. We consider mobile and pager numbers possible
* candidates for carrier lookup.
*
- * @param number a valid phone number for which we want to get a text description
- * @param languageCode the language code for which the description should be written
- * @return a text description for the given language code for the given phone number
+ * @param number a valid phone number for which we want to get a carrier name
+ * @param languageCode the language code in which the name should be written
+ * @return a carrier name for the given phone number
*/
- public String getDescriptionForValidNumber(PhoneNumber number, Locale languageCode) {
+ public String getNameForValidNumber(PhoneNumber number, Locale languageCode) {
String langStr = languageCode.getLanguage();
String scriptStr = ""; // No script is specified
String regionStr = languageCode.getCountry();
}
/**
- * As per {@link #getDescriptionForValidNumber(PhoneNumber, Locale)} but explicitly checks
- * the validity of the number passed in.
+ * Gets the name of the carrier for the given phone number, in the language provided. As per
+ * {@link #getNameForValidNumber(PhoneNumber, Locale)} but explicitly checks the validity of
+ * the number passed in.
*
- * @param number the phone number for which we want to get a text description
- * @param languageCode the language code for which the description should be written
- * @return a text description for the given language code for the given phone number, or empty
- * string if the number passed in is invalid
+ * @param number the phone number for which we want to get a carrier name
+ * @param languageCode the language code in which the name should be written
+ * @return a carrier name for the given phone number, or empty string if the number passed in is
+ * invalid
*/
- public String getDescriptionForNumber(PhoneNumber number, Locale languageCode) {
+ public String getNameForNumber(PhoneNumber number, Locale languageCode) {
PhoneNumberType numberType = phoneUtil.getNumberType(number);
if (isMobile(numberType)) {
- return getDescriptionForValidNumber(number, languageCode);
+ return getNameForValidNumber(number, languageCode);
}
return "";
}
/**
+ * Gets the name of the carrier for the given phone number only when it is 'safe' to display to
+ * users. A carrier name is considered safe if the number is valid and for a region that doesn't
+ * support
+ * {@linkplain http://en.wikipedia.org/wiki/Mobile_number_portability mobile number portability}.
+ *
+ * @param number the phone number for which we want to get a carrier name
+ * @param languageCode the language code in which the name should be written
+ * @return a carrier name that is safe to display to users, or the empty string
+ */
+ public String getSafeDisplayName(PhoneNumber number, Locale languageCode) {
+ if (phoneUtil.isMobileNumberPortableRegion(phoneUtil.getRegionCodeForNumber(number))) {
+ return "";
+ }
+ return getNameForNumber(number, languageCode);
+ }
+
+ /**
* Checks if the supplied number type supports carrier lookup.
*/
private boolean isMobile(PhoneNumberType numberType) {
private static final PhoneNumber INTERNATIONAL_TOLL_FREE =
new PhoneNumber().setCountryCode(800).setNationalNumber(12345678L);
- public void testGetDescriptionForMobilePortableRegion() {
+ public void testGetNameForMobilePortableRegion() {
assertEquals("British carrier",
- carrierMapper.getDescriptionForNumber(UK_MOBILE1, Locale.ENGLISH));
+ carrierMapper.getNameForNumber(UK_MOBILE1, Locale.ENGLISH));
assertEquals("Brittisk operatör",
- carrierMapper.getDescriptionForNumber(UK_MOBILE1, new Locale("sv", "SE")));
+ carrierMapper.getNameForNumber(UK_MOBILE1, new Locale("sv", "SE")));
assertEquals("British carrier",
- carrierMapper.getDescriptionForNumber(UK_MOBILE1, Locale.FRENCH));
+ carrierMapper.getNameForNumber(UK_MOBILE1, Locale.FRENCH));
+ // Returns an empty string because the UK implements mobile number portability.
+ assertEquals("", carrierMapper.getSafeDisplayName(UK_MOBILE1, Locale.ENGLISH));
}
- public void testGetDescriptionForNonMobilePortableRegion() {
+ public void testGetNameForNonMobilePortableRegion() {
assertEquals("Angolan carrier",
- carrierMapper.getDescriptionForNumber(AO_MOBILE1, Locale.ENGLISH));
+ carrierMapper.getNameForNumber(AO_MOBILE1, Locale.ENGLISH));
+ assertEquals("Angolan carrier",
+ carrierMapper.getSafeDisplayName(AO_MOBILE1, Locale.ENGLISH));
}
- public void testGetDescriptionForFixedLineNumber() {
- assertEquals("", carrierMapper.getDescriptionForNumber(AO_FIXED1, Locale.ENGLISH));
- assertEquals("", carrierMapper.getDescriptionForNumber(UK_FIXED1, Locale.ENGLISH));
+ public void testGetNameForFixedLineNumber() {
+ assertEquals("", carrierMapper.getNameForNumber(AO_FIXED1, Locale.ENGLISH));
+ assertEquals("", carrierMapper.getNameForNumber(UK_FIXED1, Locale.ENGLISH));
// If the carrier information is present in the files and the method that assumes a valid
// number is used, a carrier is returned.
assertEquals("Angolan fixed line carrier",
- carrierMapper.getDescriptionForValidNumber(AO_FIXED2, Locale.ENGLISH));
- assertEquals("", carrierMapper.getDescriptionForValidNumber(UK_FIXED2, Locale.ENGLISH));
+ carrierMapper.getNameForValidNumber(AO_FIXED2, Locale.ENGLISH));
+ assertEquals("", carrierMapper.getNameForValidNumber(UK_FIXED2, Locale.ENGLISH));
}
- public void testGetDescriptionForFixedOrMobileNumber() {
- assertEquals("US carrier", carrierMapper.getDescriptionForNumber(US_FIXED_OR_MOBILE,
+ public void testGetNameForFixedOrMobileNumber() {
+ assertEquals("US carrier", carrierMapper.getNameForNumber(US_FIXED_OR_MOBILE,
Locale.ENGLISH));
}
- public void testGetDescriptionForPagerNumber() {
- assertEquals("British pager", carrierMapper.getDescriptionForNumber(UK_PAGER, Locale.ENGLISH));
+ public void testGetNameForPagerNumber() {
+ assertEquals("British pager", carrierMapper.getNameForNumber(UK_PAGER, Locale.ENGLISH));
}
- public void testGetDescriptionForNumberWithNoDataFile() {
- assertEquals("", carrierMapper.getDescriptionForNumber(NUMBER_WITH_INVALID_COUNTRY_CODE,
+ public void testGetNameForNumberWithNoDataFile() {
+ assertEquals("", carrierMapper.getNameForNumber(NUMBER_WITH_INVALID_COUNTRY_CODE,
Locale.ENGLISH));
- assertEquals("", carrierMapper.getDescriptionForNumber(INTERNATIONAL_TOLL_FREE,
+ assertEquals("", carrierMapper.getNameForNumber(INTERNATIONAL_TOLL_FREE,
Locale.ENGLISH));
- assertEquals("", carrierMapper.getDescriptionForValidNumber(NUMBER_WITH_INVALID_COUNTRY_CODE,
+ assertEquals("", carrierMapper.getNameForValidNumber(NUMBER_WITH_INVALID_COUNTRY_CODE,
Locale.ENGLISH));
- assertEquals("", carrierMapper.getDescriptionForValidNumber(INTERNATIONAL_TOLL_FREE,
+ assertEquals("", carrierMapper.getNameForValidNumber(INTERNATIONAL_TOLL_FREE,
Locale.ENGLISH));
}
- public void testGetDescriptionForNumberWithMissingPrefix() {
- assertEquals("", carrierMapper.getDescriptionForNumber(UK_MOBILE2, Locale.ENGLISH));
- assertEquals("", carrierMapper.getDescriptionForNumber(AO_MOBILE2, Locale.ENGLISH));
+ public void testGetNameForNumberWithMissingPrefix() {
+ assertEquals("", carrierMapper.getNameForNumber(UK_MOBILE2, Locale.ENGLISH));
+ assertEquals("", carrierMapper.getNameForNumber(AO_MOBILE2, Locale.ENGLISH));
}
- public void testGetDescriptionForInvalidNumber() {
- assertEquals("", carrierMapper.getDescriptionForNumber(UK_INVALID_NUMBER, Locale.ENGLISH));
- assertEquals("", carrierMapper.getDescriptionForNumber(AO_INVALID_NUMBER, Locale.ENGLISH));
+ public void testGetNameForInvalidNumber() {
+ assertEquals("", carrierMapper.getNameForNumber(UK_INVALID_NUMBER, Locale.ENGLISH));
+ assertEquals("", carrierMapper.getNameForNumber(AO_INVALID_NUMBER, Locale.ENGLISH));
}
}
output.append("<TR><TD colspan=2>PhoneNumberToCarrierMapper Results</TD></TR>");
appendLine(
"Carrier",
- PhoneNumberToCarrierMapper.getInstance().getDescriptionForNumber(
+ PhoneNumberToCarrierMapper.getInstance().getNameForNumber(
number, new Locale(languageCode, regionCode)),
output);
output.append("</TABLE>");
String nationalSignificantNumber = getNationalSignificantNumber(number);
return !isNumberMatchingDesc(nationalSignificantNumber, metadata.getNoInternationalDialling());
}
+
+ /**
+ * Returns true if the supplied region supports mobile number portability. Returns false for
+ * invalid, unknown or regions that don't support mobile number portability.
+ *
+ * @param regionCode the region for which we want to know whether it supports mobile number
+ * portability or not.
+ */
+ public boolean isMobileNumberPortableRegion(String regionCode) {
+ PhoneMetadata metadata = getMetadataForRegion(regionCode);
+ if (metadata == null) {
+ logger.log(Level.WARNING, "Invalid or unknown region code provided: " + regionCode);
+ return false;
+ }
+ return metadata.isMobileNumberPortableRegion();
+ }
}
assertFalse(phoneUtil.isAlphaNumber("1800 123-1234 extension: 1234"));
assertFalse(phoneUtil.isAlphaNumber("+800 1234-1234"));
}
+
+ public void testIsMobileNumberPortableRegion() {
+ assertTrue(phoneUtil.isMobileNumberPortableRegion(RegionCode.US));
+ assertTrue(phoneUtil.isMobileNumberPortableRegion(RegionCode.GB));
+ assertFalse(phoneUtil.isMobileNumberPortableRegion(RegionCode.AE));
+ assertFalse(phoneUtil.isMobileNumberPortableRegion(RegionCode.BS));
+ }
}
+Oct 8, 2013: libphonenumber-5.8.7
+* Code changes:
+ - New method in the PhoneNumberUtil API - isMobileNumberPortableRegion.
+ - Carrier mapper: Updated API and added a getSafeDisplayName method that only returns the carrier
+ if it's safe to display to the user.
+
Oct 7, 2013:
* Code changes:
- Added PhoneNumberToTimeZonesMapper including unittests to the geocoder maven project.
<!-- United Kingdom -->
<territory id="GB" countryCode="44" internationalPrefix="00"
- nationalPrefix="0" nationalPrefixFormattingRule="($NP$FG)">
+ nationalPrefix="0" nationalPrefixFormattingRule="($NP$FG)"
+ mobileNumberPortableRegion="true">
<availableFormats>
<numberFormat pattern="(\d{2})(\d{4})(\d{4})">
<leadingDigits>[1-59]|[78]0</leadingDigits>
<!-- For testing purposes, numbers starting with 24 are not considered US numbers.-->
<territory id="US" countryCode="1" internationalPrefix="011"
preferredExtnPrefix=" extn. " nationalPrefix="1"
- mainCountryForCode="true" nationalPrefixOptionalWhenFormatting="true">
+ mainCountryForCode="true" nationalPrefixOptionalWhenFormatting="true"
+ mobileNumberPortableRegion="true">
<availableFormats>
<numberFormat pattern="(\d{3})(\d{4})">
<format>$1 $2</format>
projects / platform / upstream / libphonenumber.git / commitdiff