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 import com.google.i18n.phonenumbers.internal.GeoEntityUtility; 21 22 /** 23 * A source of phone metadata split by geographical regions. 24 */ 25 public interface RegionMetadataSource { 26 27 /** 28 * Returns phone metadata for provided geographical region. 29 * 30 * <p>The {@code regionCode} must be different from {@link 31 * GeoEntityUtility#REGION_CODE_FOR_NON_GEO_ENTITIES}, which has a special meaning and is used to 32 * mark non-geographical regions (see {@link NonGeographicalEntityMetadataSource} for more 33 * information). 34 * 35 * @return the phone metadata for provided {@code regionCode}, or null if there is none. 36 * @throws IllegalArgumentException if provided {@code regionCode} is {@link 37 * GeoEntityUtility#REGION_CODE_FOR_NON_GEO_ENTITIES} 38 */ getMetadataForRegion(String regionCode)39 PhoneMetadata getMetadataForRegion(String regionCode); 40 } 41