| OLD | NEW |
| (Empty) |
| 1 /* | |
| 2 * Copyright (c) 2014, the Dart project authors. | |
| 3 * | |
| 4 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not u
se this file except | |
| 5 * in compliance with the License. You may obtain a copy of the License at | |
| 6 * | |
| 7 * http://www.eclipse.org/legal/epl-v10.html | |
| 8 * | |
| 9 * Unless required by applicable law or agreed to in writing, software distribut
ed under the License | |
| 10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY K
IND, either express | |
| 11 * or implied. See the License for the specific language governing permissions a
nd limitations under | |
| 12 * the License. | |
| 13 */ | |
| 14 package com.google.dart.server; | |
| 15 | |
| 16 import com.google.dart.server.generated.types.Element; | |
| 17 import com.google.dart.server.generated.types.Location; | |
| 18 | |
| 19 import java.util.List; | |
| 20 | |
| 21 /** | |
| 22 * The interface {@code SearchResult} defines the behavior of objects that repre
sent a search | |
| 23 * result. | |
| 24 * | |
| 25 * @coverage dart.server | |
| 26 */ | |
| 27 public interface SearchResult { | |
| 28 /** | |
| 29 * An empty array of {@link SearchResult}s. | |
| 30 */ | |
| 31 SearchResult[] EMPTY_ARRAY = new SearchResult[0]; | |
| 32 | |
| 33 /** | |
| 34 * Return the kind to this result. | |
| 35 * | |
| 36 * @return the kind of this result | |
| 37 */ | |
| 38 public SearchResultKind getKind(); | |
| 39 | |
| 40 /** | |
| 41 * Return the location of the code that matched the search criteria. | |
| 42 * | |
| 43 * @return the location | |
| 44 */ | |
| 45 public Location getLocation(); | |
| 46 | |
| 47 /** | |
| 48 * Return the path to this result starting with the element that encloses it,
then for its | |
| 49 * enclosing element, etc up to the library. | |
| 50 * | |
| 51 * @return the path to this result | |
| 52 */ | |
| 53 public List<Element> getPath(); | |
| 54 | |
| 55 /** | |
| 56 * Return {@code true} is this search result is a potential reference to a cla
ss member. | |
| 57 * | |
| 58 * @return {@code true} is this search result is a potential reference to a cl
ass member | |
| 59 */ | |
| 60 public boolean isPotential(); | |
| 61 } | |
| OLD | NEW |