1 /* 2 * Copyright (C) 2014 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.internal; 18 19 import com.google.i18n.phonenumbers.Phonemetadata.PhoneNumberDesc; 20 21 /** 22 * Internal phonenumber matching API used to isolate the underlying implementation of the 23 * matcher and allow different implementations to be swapped in easily. 24 */ 25 public interface MatcherApi { 26 /** 27 * Returns whether the given national number (a string containing only decimal digits) matches 28 * the national number pattern defined in the given {@code PhoneNumberDesc} message. 29 */ matchesNationalNumber(String nationalNumber, PhoneNumberDesc numberDesc, boolean allowPrefixMatch)30 boolean matchesNationalNumber(String nationalNumber, PhoneNumberDesc numberDesc, 31 boolean allowPrefixMatch); 32 33 /** 34 * Returns whether the given national number (a string containing only decimal digits) matches 35 * the possible number pattern defined in the given {@code PhoneNumberDesc} message. 36 */ matchesPossibleNumber(String nationalNumber, PhoneNumberDesc numberDesc)37 boolean matchesPossibleNumber(String nationalNumber, PhoneNumberDesc numberDesc); 38 } 39