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

Public Member Functions
	SourceEdit (int offset, int length, String replacement, String id, String description)
boolean	equals (Object obj)
String	getDescription ()
String	getId ()
int	getLength ()
int	getOffset ()
String	getReplacement ()
int	hashCode ()
JsonObject	toJson ()
String	toString ()

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

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

Detailed Description

A description of a single change to a single file.

@coverage dart.server.generated.types

Definition at line 32 of file SourceEdit.java.

Constructor & Destructor Documentation

SourceEdit()

org.dartlang.analysis.server.protocol.SourceEdit.SourceEdit ( int  offset, int  length, String  replacement, String  id, String  description  )

inline

Constructor for SourceEdit.

Definition at line 79 of file SourceEdit.java.

                                                                                               {
    this.offset = offset;
    this.length = length;
    this.replacement = replacement;
    this.id = id;
    this.description = description;
  }

Member Function Documentation

equals()

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

inline

Definition at line 88 of file SourceEdit.java.

                                    {
    if (obj instanceof SourceEdit) {
      SourceEdit other = (SourceEdit) obj;
      return
        other.offset == offset &&
        other.length == length &&
        ObjectUtilities.equals(other.replacement, replacement) &&
        ObjectUtilities.equals(other.id, id) &&
        ObjectUtilities.equals(other.description, description);
    }
    return false;
  }

fromJson()

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

inlinestatic

Definition at line 101 of file SourceEdit.java.

                                                           {
    int offset = jsonObject.get("offset").getAsInt();
    int length = jsonObject.get("length").getAsInt();
    String replacement = jsonObject.get("replacement").getAsString();
    String id = jsonObject.get("id") == null ? null : jsonObject.get("id").getAsString();
    String description = jsonObject.get("description") == null ? null : jsonObject.get("description").getAsString();
    return new SourceEdit(offset, length, replacement, id, description);
  }

fromJsonArray()

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

inlinestatic

Definition at line 110 of file SourceEdit.java.

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

getDescription()

String org.dartlang.analysis.server.protocol.SourceEdit.getDescription ( )

inline

A human readable description of the change made by this edit.

This description should be short and suitable to use as a heading with changes grouped by it. For example, a change made as part of a quick-fix may use the message "Replace final with var", allowing multiple changes and multiple applications of the fix to be grouped together.

This value may be more specific than any value in an enclosing SourceChange.message which could contain edits made for different reasons (such as during a bulk fix operation).

Definition at line 132 of file SourceEdit.java.

                                 {
    return description;
  }

getId()

String org.dartlang.analysis.server.protocol.SourceEdit.getId ( )

inline

An identifier that uniquely identifies this source edit from other edits in the same response. This field is omitted unless a containing structure needs to be able to identify the edit for some reason.

For example, some refactoring operations can produce edits that might not be appropriate (referred to as potential edits). Such edits will have an id so that they can be referenced. Edits in the same response that do not need to be referenced will not have an id.

Definition at line 145 of file SourceEdit.java.

                        {
    return id;
  }

getLength()

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

inline

The length of the region to be modified.

Definition at line 152 of file SourceEdit.java.

                         {
    return length;
  }

getOffset()

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

inline

The offset of the region to be modified.

Definition at line 159 of file SourceEdit.java.

                         {
    return offset;
  }

getReplacement()

String org.dartlang.analysis.server.protocol.SourceEdit.getReplacement ( )

inline

The code that is to replace the specified region in the original code.

Definition at line 166 of file SourceEdit.java.

                                 {
    return replacement;
  }

hashCode()

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

inline

Definition at line 171 of file SourceEdit.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(offset);
    builder.append(length);
    builder.append(replacement);
    builder.append(id);
    builder.append(description);
    return builder.toHashCode();
  }

toJson()

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

inline

Definition at line 181 of file SourceEdit.java.

                             {
    JsonObject jsonObject = new JsonObject();
    jsonObject.addProperty("offset", offset);
    jsonObject.addProperty("length", length);
    jsonObject.addProperty("replacement", replacement);
    if (id != null) {
      jsonObject.addProperty("id", id);
    }
    if (description != null) {
      jsonObject.addProperty("description", description);
    }
    return jsonObject;
  }

toString()

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

inline

Definition at line 196 of file SourceEdit.java.

                           {
    StringBuilder builder = new StringBuilder();
    builder.append("[");
    builder.append("offset=");
    builder.append(offset + ", ");
    builder.append("length=");
    builder.append(length + ", ");
    builder.append("replacement=");
    builder.append(replacement + ", ");
    builder.append("id=");
    builder.append(id + ", ");
    builder.append("description=");
    builder.append(description);
    builder.append("]");
    return builder.toString();
  }

Member Data Documentation

EMPTY_ARRAY

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

static

Definition at line 34 of file SourceEdit.java.

EMPTY_LIST

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

static

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