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 /** A source of formatting phone metadata. */ 22 public interface FormattingMetadataSource { 23 24 /** 25 * Returns formatting phone metadata for provided country calling code. 26 * 27 * <p>This method is similar to the one in {@link 28 * NonGeographicalEntityMetadataSource#getMetadataForNonGeographicalRegion(int)}, except that it 29 * will not fail for geographical regions, it can be used for both geo- and non-geo entities. 30 * 31 * <p>In case the provided {@code countryCallingCode} maps to several different regions, only one 32 * would contain formatting metadata. 33 * 34 * @return the phone metadata for provided {@code countryCallingCode}, or null if there is none. 35 */ getFormattingMetadataForCountryCallingCode(int countryCallingCode)36 PhoneMetadata getFormattingMetadataForCountryCallingCode(int countryCallingCode); 37 } 38