git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.tr064.internal.phonebook;
  14
  15 import java.util.Optional;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18
  19 /**
  20  * The {@link Phonebook} interface is used by phonebook providers to implement phonebooks
  21  *
  22  * @author Jan N. Klug - Initial contribution
  23  */
  24 @NonNullByDefault
  25 public interface Phonebook {
  26
  27     /**
  28      * get the name of this phonebook
  29      *
  30      * @return
  31      */
  32     String getName();
  33
  34     /**
  35      * lookup a number in this phonebook
  36      *
  37      * @param number the number
  38      * @param matchCount the number of matching digits, counting from far right
  39      * @return an Optional containing the name associated with this number (empty of not present)
  40      */
  41     Optional<String> lookupNumber(String number, int matchCount);
  42 }