saker.build Documentation TaskDoc JavaDoc Packages
public interface CompletionProposalEdit
Common superinterface for the possible completion proposal related document changes.

The actual change is based on the kind of the edit and the related implementation class.

Each completion proposal edit has a range which it replaces in the originating source document. The range is defined by a file offset and a region length. When the edit is applied, the characters will be replaced in the document to the contents of the edit based on its kind. The specified range may be empty to signal an insertion. The offsets in the range is relative to the file offsets of the original document when the proposal request was invoked.

Subsequent proposal edits in a proposal may not overlap in range.

Methods
public boolean
Checks if this completion proposal edit has the same kind and semantics as the parameter.
public String
The kind of the edit to be applied to the document.
public int
Gets the region length of this proposal edit.
public int
Gets the region starting offset of this proposal edit.
public int
Gets the hash code of this completion proposal edit.
public static boolean
Checks if the ranges specified by the argument proposal edits overlap.
public abstract boolean equals(Object obj)
Checks if this completion proposal edit has the same kind and semantics as the parameter.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

true if this object is the same as the obj argument; false otherwise.
public abstract String getKind()
The kind of the edit to be applied to the document.
The kind.
public abstract int getLength()
Gets the region length of this proposal edit.
The region length.
public abstract int getOffset()
Gets the region starting offset of this proposal edit.
The offset.
public abstract int hashCode()
Gets the hash code of this completion proposal edit.

The hash code is defined to be the hash code of the following:

 getKind().hashCode() ^ getOffset() ^ getLength()
 

Returns a hash code value for the object.This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.
Checks if the ranges specified by the argument proposal edits overlap.
r1The first proposal edit.
r2The second proposal edit.
true if the ranges overlap.