1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * See LICENSE.txt included in this distribution for the specific 9 * language governing permissions and limitations under the License. 10 * 11 * When distributing Covered Code, include this CDDL HEADER in each 12 * file and include the License file at LICENSE.txt. 13 * If applicable, add the following below this CDDL HEADER, with the 14 * fields enclosed by brackets "[]" replaced with your own identifying 15 * information: Portions Copyright [yyyy] [name of copyright owner] 16 * 17 * CDDL HEADER END 18 */ 19 20 /* 21 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved. 22 */ 23 package org.opengrok.suggest.popular; 24 25 import org.apache.lucene.util.BytesRef; 26 27 /** 28 * Simple interface for accessing the popularity data for specific terms. 29 */ 30 @FunctionalInterface 31 public interface PopularityCounter { 32 33 /** 34 * For the term {@code key} returns the number the term was searched for. 35 * @param key the term to retrieve data for 36 * @return number of times the {@code key} was searched for 37 */ get(BytesRef key)38 int get(BytesRef key); 39 40 } 41