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

http://github.com/hudson/hudson · Java · 51 lines · 12 code · 4 blank · 35 comment · 0 complexity · 6c0c356713727589f813213f777e07bd MD5 · raw file

  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. import java.util.List;
  26. /**
  27. * @author Kohsuke Kawaguchi
  28. */
  29. public interface SearchIndex {
  30. void find(String token, List<SearchItem> result);
  31. /**
  32. *
  33. * This method returns the superset of {@link #find(String, List)}.
  34. */
  35. void suggest(String token, List<SearchItem> result);
  36. /**
  37. * Empty set.
  38. */
  39. static final SearchIndex EMPTY = new SearchIndex() {
  40. public void find(String token, List<SearchItem> result) {
  41. // no item to contribute
  42. }
  43. public void suggest(String token, List<SearchItem> result) {
  44. // nothing to suggest
  45. }
  46. };
  47. }