Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class LinkedEditingRanges

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

The linked editing range response is sent from the server to the client to return the range of the symbol at the given position and all ranges that have the same content.

Optionally a word pattern can be returned to describe valid contents.

Since 3.16.0

Field Summary

Modifier and TypeField and Description
private List<Range>
ranges

A list of ranges that can be renamed together.

private String
wordPattern

An optional word pattern (regular expression) that describes valid contents for the given ranges.

Constructor Summary

AccessConstructor and Description
public
public
public
LinkedEditingRanges(final List<Range> ranges, final String wordPattern)

Method Summary

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

Overrides java.lang.Object.equals.

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

public List<Range>
getRanges()

A list of ranges that can be renamed together.

public String
getWordPattern()

An optional word pattern (regular expression) that describes valid contents for the given ranges.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setRanges(final List<Range> ranges)

A list of ranges that can be renamed together.

public void
setWordPattern(final String wordPattern)

An optional word pattern (regular expression) that describes valid contents for the given ranges.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

rangesback to summary
private List<Range> ranges

A list of ranges that can be renamed together. The ranges must have identical length and contain identical text content. The ranges cannot overlap.

Annotations
@NonNull
wordPatternback to summary
private String wordPattern

An optional word pattern (regular expression) that describes valid contents for the given ranges. If no pattern is provided, the client configuration's word pattern will be used.

Constructor Detail

LinkedEditingRangesback to summary
public LinkedEditingRanges()
LinkedEditingRangesback to summary
public LinkedEditingRanges(final List<Range> ranges)
LinkedEditingRangesback to summary
public LinkedEditingRanges(final List<Range> ranges, final String wordPattern)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides java.lang.Object.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
getRangesback to summary
public List<Range> getRanges()

A list of ranges that can be renamed together. The ranges must have identical length and contain identical text content. The ranges cannot overlap.

Annotations
@NonNull
getWordPatternback to summary
public String getWordPattern()

An optional word pattern (regular expression) that describes valid contents for the given ranges. If no pattern is provided, the client configuration's word pattern will be used.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
setRangesback to summary
public void setRanges(final List<Range> ranges)

A list of ranges that can be renamed together. The ranges must have identical length and contain identical text content. The ranges cannot overlap.

setWordPatternback to summary
public void setWordPattern(final String wordPattern)

An optional word pattern (regular expression) that describes valid contents for the given ranges. If no pattern is provided, the client configuration's word pattern will be used.

toStringback to summary
public String toString()

Overrides java.lang.Object.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