org.dartlang.analysis.server.protocol.SearchResult Class Reference

Public Member Functions
	SearchResult (Location location, String kind, boolean isPotential, List< Element > path)
boolean	equals (Object obj)
boolean	isPotential ()
String	getKind ()
Location	getLocation ()
List< Element >	getPath ()
int	hashCode ()
JsonObject	toJson ()
String	toString ()

Static Public Member Functions
static SearchResult	fromJson (JsonObject jsonObject)
static List< SearchResult >	fromJsonArray (JsonArray jsonArray)

Static Public Attributes
static final SearchResult[]	EMPTY_ARRAY = new SearchResult[0]
static final List< SearchResult >	EMPTY_LIST = Lists.newArrayList()

Detailed Description

A single result from a search request.

@coverage dart.server.generated.types

Definition at line 32 of file SearchResult.java.

Constructor & Destructor Documentation

SearchResult()

org.dartlang.analysis.server.protocol.SearchResult.SearchResult ( Location  location, String  kind, boolean  isPotential, List< Element >  path  )

inline

Constructor for SearchResult.

Definition at line 64 of file SearchResult.java.

                                                                                               {
    this.location = location;
    this.kind = kind;
    this.isPotential = isPotential;
    this.path = path;
  }

Member Function Documentation

equals()

boolean org.dartlang.analysis.server.protocol.SearchResult.equals ( Object  obj )

inline

Definition at line 72 of file SearchResult.java.

                                    {
    if (obj instanceof SearchResult) {
      SearchResult other = (SearchResult) obj;
      return
        ObjectUtilities.equals(other.location, location) &&
        ObjectUtilities.equals(other.kind, kind) &&
        other.isPotential == isPotential &&
        ObjectUtilities.equals(other.path, path);
    }
    return false;
  }

fromJson()

static SearchResult org.dartlang.analysis.server.protocol.SearchResult.fromJson ( JsonObject  jsonObject )

inlinestatic

Definition at line 84 of file SearchResult.java.

                                                             {
    Location location = Location.fromJson(jsonObject.get("location").getAsJsonObject());
    String kind = jsonObject.get("kind").getAsString();
    boolean isPotential = jsonObject.get("isPotential").getAsBoolean();
    List<Element> path = Element.fromJsonArray(jsonObject.get("path").getAsJsonArray());
    return new SearchResult(location, kind, isPotential, path);
  }

fromJsonArray()

static List< SearchResult > org.dartlang.analysis.server.protocol.SearchResult.fromJsonArray ( JsonArray  jsonArray )

inlinestatic

Definition at line 92 of file SearchResult.java.

                                                                      {
    if (jsonArray == null) {
      return EMPTY_LIST;
    }
    ArrayList<SearchResult> list = new ArrayList<SearchResult>(jsonArray.size());
    Iterator<JsonElement> iterator = jsonArray.iterator();
    while (iterator.hasNext()) {
      list.add(fromJson(iterator.next().getAsJsonObject()));
    }
    return list;
  }

getKind()

String org.dartlang.analysis.server.protocol.SearchResult.getKind ( )

inline

The kind of element that was found or the kind of reference that was found.

Definition at line 116 of file SearchResult.java.

                          {
    return kind;
  }

getLocation()

Location org.dartlang.analysis.server.protocol.SearchResult.getLocation ( )

inline

The location of the code that matched the search criteria.

Definition at line 123 of file SearchResult.java.

                                {
    return location;
  }

getPath()

List< Element > org.dartlang.analysis.server.protocol.SearchResult.getPath ( )

inline

The elements that contain the result, starting with the most immediately enclosing ancestor and ending with the library.

Definition at line 131 of file SearchResult.java.

                                 {
    return path;
  }

hashCode()

int org.dartlang.analysis.server.protocol.SearchResult.hashCode ( )

inline

Definition at line 136 of file SearchResult.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(location);
    builder.append(kind);
    builder.append(isPotential);
    builder.append(path);
    return builder.toHashCode();
  }

isPotential()

boolean org.dartlang.analysis.server.protocol.SearchResult.isPotential ( )

inline

True if the result is a potential match but cannot be confirmed to be a match. For example, if all references to a method m defined in some class were requested, and a reference to a method m from an unknown class were found, it would be marked as being a potential match.

Definition at line 109 of file SearchResult.java.

                               {
    return isPotential;
  }

toJson()

JsonObject org.dartlang.analysis.server.protocol.SearchResult.toJson ( )

inline

Definition at line 145 of file SearchResult.java.

                             {
    JsonObject jsonObject = new JsonObject();
    jsonObject.add("location", location.toJson());
    jsonObject.addProperty("kind", kind);
    jsonObject.addProperty("isPotential", isPotential);
    JsonArray jsonArrayPath = new JsonArray();
    for (Element elt : path) {
      jsonArrayPath.add(elt.toJson());
    }
    jsonObject.add("path", jsonArrayPath);
    return jsonObject;
  }

toString()

String org.dartlang.analysis.server.protocol.SearchResult.toString ( )

inline

Definition at line 159 of file SearchResult.java.

                           {
    StringBuilder builder = new StringBuilder();
    builder.append("[");
    builder.append("location=");
    builder.append(location + ", ");
    builder.append("kind=");
    builder.append(kind + ", ");
    builder.append("isPotential=");
    builder.append(isPotential + ", ");
    builder.append("path=");
    builder.append(StringUtils.join(path, ", "));
    builder.append("]");
    return builder.toString();
  }

Member Data Documentation

EMPTY_ARRAY

final SearchResult [] org.dartlang.analysis.server.protocol.SearchResult.EMPTY_ARRAY = new SearchResult[0]

static

Definition at line 34 of file SearchResult.java.

EMPTY_LIST

final List<SearchResult> org.dartlang.analysis.server.protocol.SearchResult.EMPTY_LIST = Lists.newArrayList()

static

Definition at line 36 of file SearchResult.java.

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/pkg/analysis_server/tool/spec/generated/java/types/SearchResult.java