File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\search\SearchIndex.java.html

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 */
24 package hudson.search;
25
26 import java.util.List;
27
28 /**
29 * Conceptually a set of {@link SearchItem}s that provide quick look-up
30 * from their {@linkplain SearchItem#getSearchName() names}.
31 *
32 * @author Kohsuke Kawaguchi
33 * @see SearchIndexBuilder
34 */
35 public interface SearchIndex {
36 void find(String token, List<SearchItem> result);
37
38 /**
39 *
40 * This method returns the superset of {@link #find(String, List)}.
41 */
42 void suggest(String token, List<SearchItem> result);
43
44 /**
45 * Empty set.
46 */
47 SearchIndex EMPTY = new SearchIndex() {
48 public void find(String token, List<SearchItem> result) {
49 // no item to contribute
50 }
51 public void suggest(String token, List<SearchItem> result) {
52 // nothing to suggest
53 }
54 };
55 }
56