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

Public Member Functions
	ChangeContentOverlay (List< SourceEdit > edits)
boolean	equals (Object obj)
List< SourceEdit >	getEdits ()
String	getType ()
int	hashCode ()
JsonObject	toJson ()
String	toString ()

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

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

Detailed Description

A directive to modify an existing file content overlay. One or more ranges of text are deleted from the old file content overlay and replaced with new text.

The edits are applied in the order in which they occur in the list. This means that the offset of each edit must be correct under the assumption that all previous edits have been applied.

It is an error to use this overlay on a file that does not yet have a file content overlay or that has had its overlay removed via RemoveContentOverlay.

If any of the edits cannot be applied due to its offset or length being out of range, an INVALID_OVERLAY_CHANGE error will be reported.

@coverage dart.server.generated.types

Definition at line 42 of file ChangeContentOverlay.java.

Constructor & Destructor Documentation

ChangeContentOverlay()

org.dartlang.analysis.server.protocol.ChangeContentOverlay.ChangeContentOverlay ( List< SourceEdit >  edits )

inline

Constructor for ChangeContentOverlay.

Definition at line 58 of file ChangeContentOverlay.java.

                                                      {
    this.type = "change";
    this.edits = edits;
  }

Member Function Documentation

equals()

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

inline

Definition at line 64 of file ChangeContentOverlay.java.

                                    {
    if (obj instanceof ChangeContentOverlay) {
      ChangeContentOverlay other = (ChangeContentOverlay) obj;
      return
        ObjectUtilities.equals(other.type, type) &&
        ObjectUtilities.equals(other.edits, edits);
    }
    return false;
  }

fromJson()

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

inlinestatic

Definition at line 74 of file ChangeContentOverlay.java.

                                                                     {
    String type = jsonObject.get("type").getAsString();
    List<SourceEdit> edits = SourceEdit.fromJsonArray(jsonObject.get("edits").getAsJsonArray());
    return new ChangeContentOverlay(edits);
  }

fromJsonArray()

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

inlinestatic

Definition at line 80 of file ChangeContentOverlay.java.

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

getEdits()

List< SourceEdit > org.dartlang.analysis.server.protocol.ChangeContentOverlay.getEdits ( )

inline

The edits to be applied to the file.

Definition at line 95 of file ChangeContentOverlay.java.

                                     {
    return edits;
  }

getType()

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

inline

Definition at line 99 of file ChangeContentOverlay.java.

                          {
    return type;
  }

hashCode()

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

inline

Definition at line 104 of file ChangeContentOverlay.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(type);
    builder.append(edits);
    return builder.toHashCode();
  }

toJson()

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

inline

Definition at line 111 of file ChangeContentOverlay.java.

                             {
    JsonObject jsonObject = new JsonObject();
    jsonObject.addProperty("type", type);
    JsonArray jsonArrayEdits = new JsonArray();
    for (SourceEdit elt : edits) {
      jsonArrayEdits.add(elt.toJson());
    }
    jsonObject.add("edits", jsonArrayEdits);
    return jsonObject;
  }

toString()

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

inline

Definition at line 123 of file ChangeContentOverlay.java.

                           {
    StringBuilder builder = new StringBuilder();
    builder.append("[");
    builder.append("type=");
    builder.append(type + ", ");
    builder.append("edits=");
    builder.append(StringUtils.join(edits, ", "));
    builder.append("]");
    return builder.toString();
  }

Member Data Documentation

EMPTY_ARRAY

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

static

Definition at line 44 of file ChangeContentOverlay.java.

EMPTY_LIST

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

static

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