Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class AnnotatedTextEdit

extends TextEdit
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

A special text edit with an additional change annotation.

Since 3.16.0

Field Summary

Modifier and TypeField and Description
private String
annotationId

The actual annotation identifier

Constructor Summary

AccessConstructor and Description
public
public
AnnotatedTextEdit(final Range range, final String newText, final String annotationId)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides org.eclipse.lsp4j.TextEdit.equals.

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

public String
getAnnotationId()

The actual annotation identifier

public int
hashCode()

Overrides org.eclipse.lsp4j.TextEdit.hashCode.

Returns a hash code value for this object.

public void
setAnnotationId(final String annotationId)

The actual annotation identifier

public String
toString()

Overrides org.eclipse.lsp4j.TextEdit.toString.

Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.TextEdit:
getNewTextgetRangesetNewTextsetRange

Field Detail

annotationIdback to summary
private String annotationId

The actual annotation identifier

Annotations
@NonNull

Constructor Detail

AnnotatedTextEditback to summary
public AnnotatedTextEdit()
AnnotatedTextEditback to summary
public AnnotatedTextEdit(final Range range, final String newText, final String annotationId)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.TextEdit.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getAnnotationIdback to summary
public String getAnnotationId()

The actual annotation identifier

Annotations
@NonNull
hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.TextEdit.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 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.
Annotations
@Override
setAnnotationIdback to summary
public void setAnnotationId(final String annotationId)

The actual annotation identifier

toStringback to summary
public String toString()

Overrides org.eclipse.lsp4j.TextEdit.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override