/hudson-core/src/main/java/hudson/search/SearchIndex.java

 1/*
 2 * The MIT License
 3 * 
 4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
 5 * 
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 * 
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 * 
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24package hudson.search;
25
26import java.util.List;
27
28/**
29 * @author Kohsuke Kawaguchi
30 */
31public interface SearchIndex {
32    void find(String token, List<SearchItem> result);
33
34    /**
35     *
36     * This method returns the superset of {@link #find(String, List)}.
37     */
38    void suggest(String token, List<SearchItem> result);
39
40    /**
41     * Empty set.
42     */
43    static final SearchIndex EMPTY = new SearchIndex() {
44        public void find(String token, List<SearchItem> result) {
45            // no item to contribute
46        }
47        public void suggest(String token, List<SearchItem> result) {
48            // nothing to suggest
49        }
50    };
51}