libphonenumber/src/com/google/i18n/phonenumbers/internal/MatcherApi.java

/*
 * Copyright (C) 2014 The Libphonenumber Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.i18n.phonenumbers.internal;

import com.google.i18n.phonenumbers.Phonemetadata.PhoneNumberDesc;

/**
 * Internal phonenumber matching API used to isolate the underlying implementation of the
 * matcher and allow different implementations to be swapped in easily.
 */
public interface MatcherApi {
  /**
   * Returns whether the given national number (a string containing only decimal digits) matches
   * the national number pattern defined in the given {@code PhoneNumberDesc} message.
   */
  boolean matchesNationalNumber(String nationalNumber, PhoneNumberDesc numberDesc,
      boolean allowPrefixMatch);

  /**
   * Returns whether the given national number (a string containing only decimal digits) matches
   * the possible number pattern defined in the given {@code PhoneNumberDesc} message.
   */
  boolean matchesPossibleNumber(String nationalNumber, PhoneNumberDesc numberDesc);
}