1 /* 2 * Copyright (C) 2022 The Libphonenumber Authors 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.google.i18n.phonenumbers.metadata.source; 18 19 import com.google.i18n.phonenumbers.Phonemetadata.PhoneMetadata; 20 21 /** 22 * A source of phone metadata for non-geographical entities. 23 * 24 * <p>Non-geographical entities are phone number ranges that have a country calling code, but either 25 * do not belong to an actual country (some international services), or belong to a region which has 26 * a different country calling code from the country it is part of. Examples of such ranges are 27 * those starting with: 28 * 29 * <ul> 30 * <li>800 - country code assigned to the Universal International Freephone Service 31 * <li>808 - country code assigned to the International Shared Cost Service 32 * <li>870 - country code assigned to the Pitcairn Islands 33 * <li>... 34 * </ul> 35 */ 36 public interface NonGeographicalEntityMetadataSource { 37 38 /** 39 * Gets phone metadata for a non-geographical entity. 40 * 41 * @param countryCallingCode the country calling code. 42 * @return the phone metadata for that entity, or null if there is none. 43 * @throws IllegalArgumentException if provided {@code countryCallingCode} does not belong to a 44 * non-geographical entity 45 */ getMetadataForNonGeographicalRegion(int countryCallingCode)46 PhoneMetadata getMetadataForNonGeographicalRegion(int countryCallingCode); 47 } 48