Public Member Functions
	AnalysisError (String severity, String type, Location location, String message, String correction, String code, String url, List< DiagnosticMessage > contextMessages, Boolean hasFix)

boolean	equals (Object obj)

String	getCode ()

List< DiagnosticMessage >	getContextMessages ()

String	getCorrection ()

Boolean	getHasFix ()

Location	getLocation ()

String	getMessage ()

String	getSeverity ()

String	getType ()

String	getUrl ()

int	hashCode ()

JsonObject	toJson ()

String	toString ()

Static Public Member Functions
static AnalysisError	fromJson (JsonObject jsonObject)

static List< AnalysisError >	fromJsonArray (JsonArray jsonArray)

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

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

Detailed Description

An indication of an error, warning, or hint that was produced by the analysis.

@coverage dart.server.generated.types

Definition at line 32 of file AnalysisError.java.

Constructor & Destructor Documentation

◆ AnalysisError()

org.dartlang.analysis.server.protocol.AnalysisError.AnalysisError	(	String	severity,
		String	type,
		Location	location,
		String	message,
		String	correction,
		String	code,
		String	url,
		List< DiagnosticMessage >	contextMessages,
		Boolean	hasFix
	)

inline

Constructor for AnalysisError.

Definition at line 96 of file AnalysisError.java.

                                                                                                                                                                                             {
    this.severity = severity;
    this.type = type;
    this.location = location;
    this.message = message;
    this.correction = correction;
    this.code = code;
    this.url = url;
    this.contextMessages = contextMessages;
    this.hasFix = hasFix;
  }

Member Function Documentation

◆ equals()

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

inline

Definition at line 109 of file AnalysisError.java.

                                    {
    if (obj instanceof AnalysisError) {
      AnalysisError other = (AnalysisError) obj;
      return
        ObjectUtilities.equals(other.severity, severity) &&
        ObjectUtilities.equals(other.type, type) &&
        ObjectUtilities.equals(other.location, location) &&
        ObjectUtilities.equals(other.message, message) &&
        ObjectUtilities.equals(other.correction, correction) &&
        ObjectUtilities.equals(other.code, code) &&
        ObjectUtilities.equals(other.url, url) &&
        ObjectUtilities.equals(other.contextMessages, contextMessages) &&
        ObjectUtilities.equals(other.hasFix, hasFix);
    }
    return false;
  }

◆ fromJson()

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

inlinestatic

Definition at line 126 of file AnalysisError.java.

                                                              {
    String severity = jsonObject.get("severity").getAsString();
    String type = jsonObject.get("type").getAsString();
    Location location = Location.fromJson(jsonObject.get("location").getAsJsonObject());
    String message = jsonObject.get("message").getAsString();
    String correction = jsonObject.get("correction") == null ? null : jsonObject.get("correction").getAsString();
    String code = jsonObject.get("code").getAsString();
    String url = jsonObject.get("url") == null ? null : jsonObject.get("url").getAsString();
    List<DiagnosticMessage> contextMessages = jsonObject.get("contextMessages") == null ? null : DiagnosticMessage.fromJsonArray(jsonObject.get("contextMessages").getAsJsonArray());
    Boolean hasFix = jsonObject.get("hasFix") == null ? null : jsonObject.get("hasFix").getAsBoolean();
    return new AnalysisError(severity, type, location, message, correction, code, url, contextMessages, hasFix);
  }

◆ fromJsonArray()

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

inlinestatic

Definition at line 139 of file AnalysisError.java.

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

◆ getCode()

String org.dartlang.analysis.server.protocol.AnalysisError.getCode ( )

inline

The name, as a string, of the error code associated with this error.

Definition at line 154 of file AnalysisError.java.

                          {
    return code;
  }

◆ getContextMessages()

List< DiagnosticMessage > org.dartlang.analysis.server.protocol.AnalysisError.getContextMessages ( )

inline

Additional messages associated with this diagnostic that provide context to help the user understand the diagnostic.

Definition at line 162 of file AnalysisError.java.

                                                      {
    return contextMessages;
  }

◆ getCorrection()

String org.dartlang.analysis.server.protocol.AnalysisError.getCorrection ( )

inline

The correction message to be displayed for this error. The correction message should indicate how the user can fix the error. The field is omitted if there is no correction message associated with the error code.

Definition at line 171 of file AnalysisError.java.

                                {
    return correction;
  }

◆ getHasFix()

Boolean org.dartlang.analysis.server.protocol.AnalysisError.getHasFix ( )

inline

A hint to indicate to interested clients that this error has an associated fix (or fixes). The absence of this field implies there are not known to be fixes. Note that since the operation to calculate whether fixes apply needs to be performant it is possible that complicated tests will be skipped and a false negative returned. For this reason, this attribute should be treated as a "hint". Despite the possibility of false negatives, no false positives should be returned. If a client sees this flag set they can proceed with the confidence that there are in fact associated fixes.

Definition at line 184 of file AnalysisError.java.

                             {
    return hasFix;
  }

◆ getLocation()

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

inline

The location associated with the error.

Definition at line 191 of file AnalysisError.java.

                                {
    return location;
  }

◆ getMessage()

String org.dartlang.analysis.server.protocol.AnalysisError.getMessage ( )

inline

The message to be displayed for this error. The message should indicate what is wrong with the code and why it is wrong.

Definition at line 199 of file AnalysisError.java.

                             {
    return message;
  }

◆ getSeverity()

String org.dartlang.analysis.server.protocol.AnalysisError.getSeverity ( )

inline

The severity of the error.

Definition at line 206 of file AnalysisError.java.

                              {
    return severity;
  }

◆ getType()

String org.dartlang.analysis.server.protocol.AnalysisError.getType ( )

inline

The type of the error.

Definition at line 213 of file AnalysisError.java.

                          {
    return type;
  }

◆ getUrl()

String org.dartlang.analysis.server.protocol.AnalysisError.getUrl ( )

inline

The URL of a page containing documentation associated with this error.

Definition at line 220 of file AnalysisError.java.

                         {
    return url;
  }

◆ hashCode()

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

inline

Definition at line 225 of file AnalysisError.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(severity);
    builder.append(type);
    builder.append(location);
    builder.append(message);
    builder.append(correction);
    builder.append(code);
    builder.append(url);
    builder.append(contextMessages);
    builder.append(hasFix);
    return builder.toHashCode();
  }

◆ toJson()

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

inline

Definition at line 239 of file AnalysisError.java.

                             {
    JsonObject jsonObject = new JsonObject();
    jsonObject.addProperty("severity", severity);
    jsonObject.addProperty("type", type);
    jsonObject.add("location", location.toJson());
    jsonObject.addProperty("message", message);
    if (correction != null) {
      jsonObject.addProperty("correction", correction);
    }
    jsonObject.addProperty("code", code);
    if (url != null) {
      jsonObject.addProperty("url", url);
    }
    if (contextMessages != null) {
      JsonArray jsonArrayContextMessages = new JsonArray();
      for (DiagnosticMessage elt : contextMessages) {
        jsonArrayContextMessages.add(elt.toJson());
      }
      jsonObject.add("contextMessages", jsonArrayContextMessages);
    }
    if (hasFix != null) {
      jsonObject.addProperty("hasFix", hasFix);
    }
    return jsonObject;
  }

◆ toString()

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

inline

Definition at line 266 of file AnalysisError.java.

                           {
    StringBuilder builder = new StringBuilder();
    builder.append("[");
    builder.append("severity=");
    builder.append(severity + ", ");
    builder.append("type=");
    builder.append(type + ", ");
    builder.append("location=");
    builder.append(location + ", ");
    builder.append("message=");
    builder.append(message + ", ");
    builder.append("correction=");
    builder.append(correction + ", ");
    builder.append("code=");
    builder.append(code + ", ");
    builder.append("url=");
    builder.append(url + ", ");
    builder.append("contextMessages=");
    builder.append(StringUtils.join(contextMessages, ", ") + ", ");
    builder.append("hasFix=");
    builder.append(hasFix);
    builder.append("]");
    return builder.toString();
  }

Member Data Documentation

◆ EMPTY_ARRAY

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

static

Definition at line 34 of file AnalysisError.java.

◆ EMPTY_LIST

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

static

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AnalysisError()

Member Function Documentation

◆ equals()

◆ fromJson()

◆ fromJsonArray()

◆ getCode()

◆ getContextMessages()

◆ getCorrection()

◆ getHasFix()

◆ getLocation()

◆ getMessage()

◆ getSeverity()

◆ getType()

◆ getUrl()

◆ hashCode()

◆ toJson()

◆ toString()

Member Data Documentation

◆ EMPTY_ARRAY

◆ EMPTY_LIST