Public Member Functions
	HoverInformation (int offset, int length, String containingLibraryPath, String containingLibraryName, String containingClassDescription, String dartdoc, String elementDescription, String elementKind, Boolean isDeprecated, String parameter, String propagatedType, String staticType)

boolean	equals (Object obj)

String	getContainingClassDescription ()

String	getContainingLibraryName ()

String	getContainingLibraryPath ()

String	getDartdoc ()

String	getElementDescription ()

String	getElementKind ()

Boolean	getIsDeprecated ()

int	getLength ()

int	getOffset ()

String	getParameter ()

String	getPropagatedType ()

String	getStaticType ()

int	hashCode ()

JsonObject	toJson ()

String	toString ()

Static Public Member Functions
static HoverInformation	fromJson (JsonObject jsonObject)

static List< HoverInformation >	fromJsonArray (JsonArray jsonArray)

Static Public Attributes
static final HoverInformation[]	EMPTY_ARRAY = new HoverInformation[0]

static final List< HoverInformation >	EMPTY_LIST = Lists.newArrayList()

Detailed Description

The hover information associated with a specific location.

@coverage dart.server.generated.types

Definition at line 32 of file HoverInformation.java.

Constructor & Destructor Documentation

◆ HoverInformation()

org.dartlang.analysis.server.protocol.HoverInformation.HoverInformation	(	int	offset,
		int	length,
		String	containingLibraryPath,
		String	containingLibraryName,
		String	containingClassDescription,
		String	dartdoc,
		String	elementDescription,
		String	elementKind,
		Boolean	isDeprecated,
		String	parameter,
		String	propagatedType,
		String	staticType
	)

inline

Constructor for HoverInformation.

Definition at line 116 of file HoverInformation.java.

                                                                                                                                                                                                                                                                                                  {
    this.offset = offset;
    this.length = length;
    this.containingLibraryPath = containingLibraryPath;
    this.containingLibraryName = containingLibraryName;
    this.containingClassDescription = containingClassDescription;
    this.dartdoc = dartdoc;
    this.elementDescription = elementDescription;
    this.elementKind = elementKind;
    this.isDeprecated = isDeprecated;
    this.parameter = parameter;
    this.propagatedType = propagatedType;
    this.staticType = staticType;
  }

Member Function Documentation

◆ equals()

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

inline

Definition at line 132 of file HoverInformation.java.

                                    {
    if (obj instanceof HoverInformation) {
      HoverInformation other = (HoverInformation) obj;
      return
        other.offset == offset &&
        other.length == length &&
        ObjectUtilities.equals(other.containingLibraryPath, containingLibraryPath) &&
        ObjectUtilities.equals(other.containingLibraryName, containingLibraryName) &&
        ObjectUtilities.equals(other.containingClassDescription, containingClassDescription) &&
        ObjectUtilities.equals(other.dartdoc, dartdoc) &&
        ObjectUtilities.equals(other.elementDescription, elementDescription) &&
        ObjectUtilities.equals(other.elementKind, elementKind) &&
        ObjectUtilities.equals(other.isDeprecated, isDeprecated) &&
        ObjectUtilities.equals(other.parameter, parameter) &&
        ObjectUtilities.equals(other.propagatedType, propagatedType) &&
        ObjectUtilities.equals(other.staticType, staticType);
    }
    return false;
  }

◆ fromJson()

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

inlinestatic

Definition at line 152 of file HoverInformation.java.

                                                                 {
    int offset = jsonObject.get("offset").getAsInt();
    int length = jsonObject.get("length").getAsInt();
    String containingLibraryPath = jsonObject.get("containingLibraryPath") == null ? null : jsonObject.get("containingLibraryPath").getAsString();
    String containingLibraryName = jsonObject.get("containingLibraryName") == null ? null : jsonObject.get("containingLibraryName").getAsString();
    String containingClassDescription = jsonObject.get("containingClassDescription") == null ? null : jsonObject.get("containingClassDescription").getAsString();
    String dartdoc = jsonObject.get("dartdoc") == null ? null : jsonObject.get("dartdoc").getAsString();
    String elementDescription = jsonObject.get("elementDescription") == null ? null : jsonObject.get("elementDescription").getAsString();
    String elementKind = jsonObject.get("elementKind") == null ? null : jsonObject.get("elementKind").getAsString();
    Boolean isDeprecated = jsonObject.get("isDeprecated") == null ? null : jsonObject.get("isDeprecated").getAsBoolean();
    String parameter = jsonObject.get("parameter") == null ? null : jsonObject.get("parameter").getAsString();
    String propagatedType = jsonObject.get("propagatedType") == null ? null : jsonObject.get("propagatedType").getAsString();
    String staticType = jsonObject.get("staticType") == null ? null : jsonObject.get("staticType").getAsString();
    return new HoverInformation(offset, length, containingLibraryPath, containingLibraryName, containingClassDescription, dartdoc, elementDescription, elementKind, isDeprecated, parameter, propagatedType, staticType);
  }

◆ fromJsonArray()

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

inlinestatic

Definition at line 168 of file HoverInformation.java.

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

◆ getContainingClassDescription()

String org.dartlang.analysis.server.protocol.HoverInformation.getContainingClassDescription ( )

inline

A human-readable description of the class declaring the element being referenced. This data is omitted if there is no referenced element, or if the element is not a class member.

Definition at line 184 of file HoverInformation.java.

                                                {
    return containingClassDescription;
  }

◆ getContainingLibraryName()

String org.dartlang.analysis.server.protocol.HoverInformation.getContainingLibraryName ( )

inline

The URI of the containing library, examples here include "dart:core", "package:.." and file uris represented by the path on disk, "/..". The data is omitted if the element is declared inside an HTML file.

Definition at line 193 of file HoverInformation.java.

                                           {
    return containingLibraryName;
  }

◆ getContainingLibraryPath()

String org.dartlang.analysis.server.protocol.HoverInformation.getContainingLibraryPath ( )

inline

The path to the defining compilation unit of the library in which the referenced element is declared. This data is omitted if there is no referenced element, or if the element is declared inside an HTML file.

Definition at line 202 of file HoverInformation.java.

                                           {
    return containingLibraryPath;
  }

◆ getDartdoc()

String org.dartlang.analysis.server.protocol.HoverInformation.getDartdoc ( )

inline

The dartdoc associated with the referenced element. Other than the removal of the comment delimiters, including leading asterisks in the case of a block comment, the dartdoc is unprocessed markdown. This data is omitted if there is no referenced element, or if the element has no dartdoc.

Definition at line 212 of file HoverInformation.java.

                             {
    return dartdoc;
  }

◆ getElementDescription()

String org.dartlang.analysis.server.protocol.HoverInformation.getElementDescription ( )

inline

A human-readable description of the element being referenced. This data is omitted if there is no referenced element.

Definition at line 220 of file HoverInformation.java.

                                        {
    return elementDescription;
  }

◆ getElementKind()

String org.dartlang.analysis.server.protocol.HoverInformation.getElementKind ( )

inline

A human-readable description of the kind of element being referenced (such as "class" or "function type alias"). This data is omitted if there is no referenced element.

Definition at line 228 of file HoverInformation.java.

                                 {
    return elementKind;
  }

◆ getIsDeprecated()

Boolean org.dartlang.analysis.server.protocol.HoverInformation.getIsDeprecated ( )

inline

True if the referenced element is deprecated.

Definition at line 235 of file HoverInformation.java.

                                   {
    return isDeprecated;
  }

◆ getLength()

int org.dartlang.analysis.server.protocol.HoverInformation.getLength ( )

inline

The length of the range of characters that encompasses the cursor position and has the same hover information as the cursor position.

Definition at line 243 of file HoverInformation.java.

                         {
    return length;
  }

◆ getOffset()

int org.dartlang.analysis.server.protocol.HoverInformation.getOffset ( )

inline

The offset of the range of characters that encompasses the cursor position and has the same hover information as the cursor position.

Definition at line 251 of file HoverInformation.java.

                         {
    return offset;
  }

◆ getParameter()

String org.dartlang.analysis.server.protocol.HoverInformation.getParameter ( )

inline

A human-readable description of the parameter corresponding to the expression being hovered over. This data is omitted if the location is not in an argument to a function.

Definition at line 259 of file HoverInformation.java.

                               {
    return parameter;
  }

◆ getPropagatedType()

String org.dartlang.analysis.server.protocol.HoverInformation.getPropagatedType ( )

inline

The name of the propagated type of the expression. This data is omitted if the location does not correspond to an expression or if there is no propagated type information.

Definition at line 267 of file HoverInformation.java.

                                    {
    return propagatedType;
  }

◆ getStaticType()

String org.dartlang.analysis.server.protocol.HoverInformation.getStaticType ( )

inline

The name of the static type of the expression. This data is omitted if the location does not correspond to an expression.

Definition at line 275 of file HoverInformation.java.

                                {
    return staticType;
  }

◆ hashCode()

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

inline

Definition at line 280 of file HoverInformation.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(offset);
    builder.append(length);
    builder.append(containingLibraryPath);
    builder.append(containingLibraryName);
    builder.append(containingClassDescription);
    builder.append(dartdoc);
    builder.append(elementDescription);
    builder.append(elementKind);
    builder.append(isDeprecated);
    builder.append(parameter);
    builder.append(propagatedType);
    builder.append(staticType);
    return builder.toHashCode();
  }

◆ toJson()

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

inline

Definition at line 297 of file HoverInformation.java.

                             {
    JsonObject jsonObject = new JsonObject();
    jsonObject.addProperty("offset", offset);
    jsonObject.addProperty("length", length);
    if (containingLibraryPath != null) {
      jsonObject.addProperty("containingLibraryPath", containingLibraryPath);
    }
    if (containingLibraryName != null) {
      jsonObject.addProperty("containingLibraryName", containingLibraryName);
    }
    if (containingClassDescription != null) {
      jsonObject.addProperty("containingClassDescription", containingClassDescription);
    }
    if (dartdoc != null) {
      jsonObject.addProperty("dartdoc", dartdoc);
    }
    if (elementDescription != null) {
      jsonObject.addProperty("elementDescription", elementDescription);
    }
    if (elementKind != null) {
      jsonObject.addProperty("elementKind", elementKind);
    }
    if (isDeprecated != null) {
      jsonObject.addProperty("isDeprecated", isDeprecated);
    }
    if (parameter != null) {
      jsonObject.addProperty("parameter", parameter);
    }
    if (propagatedType != null) {
      jsonObject.addProperty("propagatedType", propagatedType);
    }
    if (staticType != null) {
      jsonObject.addProperty("staticType", staticType);
    }
    return jsonObject;
  }

◆ toString()

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

inline

Definition at line 335 of file HoverInformation.java.

                           {
    StringBuilder builder = new StringBuilder();
    builder.append("[");
    builder.append("offset=");
    builder.append(offset + ", ");
    builder.append("length=");
    builder.append(length + ", ");
    builder.append("containingLibraryPath=");
    builder.append(containingLibraryPath + ", ");
    builder.append("containingLibraryName=");
    builder.append(containingLibraryName + ", ");
    builder.append("containingClassDescription=");
    builder.append(containingClassDescription + ", ");
    builder.append("dartdoc=");
    builder.append(dartdoc + ", ");
    builder.append("elementDescription=");
    builder.append(elementDescription + ", ");
    builder.append("elementKind=");
    builder.append(elementKind + ", ");
    builder.append("isDeprecated=");
    builder.append(isDeprecated + ", ");
    builder.append("parameter=");
    builder.append(parameter + ", ");
    builder.append("propagatedType=");
    builder.append(propagatedType + ", ");
    builder.append("staticType=");
    builder.append(staticType);
    builder.append("]");
    return builder.toString();
  }

Member Data Documentation

◆ EMPTY_ARRAY

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

static

Definition at line 34 of file HoverInformation.java.

◆ EMPTY_LIST

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

static

Definition at line 36 of file HoverInformation.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/HoverInformation.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HoverInformation()

Member Function Documentation

◆ equals()

◆ fromJson()

◆ fromJsonArray()

◆ getContainingClassDescription()

◆ getContainingLibraryName()

◆ getContainingLibraryPath()

◆ getDartdoc()

◆ getElementDescription()

◆ getElementKind()

◆ getIsDeprecated()

◆ getLength()

◆ getOffset()

◆ getParameter()

◆ getPropagatedType()

◆ getStaticType()

◆ hashCode()

◆ toJson()

◆ toString()

Member Data Documentation

◆ EMPTY_ARRAY

◆ EMPTY_LIST