Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.DocumentHighlight

Modifier and Type	Field and Description
private DocumentHighlightKind	kind The highlight kind, default is `DocumentHighlightKind#Text`.
private Range	range The range this highlight applies to.

Access	Constructor and Description
public	DocumentHighlight()
public	DocumentHighlight(final Range range)
public	DocumentHighlight(final Range range, final DocumentHighlightKind kind)

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public DocumentHighlightKind	getKind() The highlight kind, default is `DocumentHighlightKind#Text`.
public Range	getRange() The range this highlight applies to.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setKind(final DocumentHighlightKind kind) The highlight kind, default is `DocumentHighlightKind#Text`.
public void	setRange(final Range range) The range this highlight applies to.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

kind	back to summary
private DocumentHighlightKind kind The highlight kind, default is `DocumentHighlightKind#Text`.

range	back to summary
private Range range The range this highlight applies to. Annotations @NonNull

Constructor Detail

DocumentHighlight	back to summary
public DocumentHighlight()

DocumentHighlight	back to summary
public DocumentHighlight(final Range range)

DocumentHighlight	back to summary
public DocumentHighlight(final Range range, final DocumentHighlightKind kind)

Method Detail

equals back to summary

equals	back 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

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

getKind	back to summary
public DocumentHighlightKind getKind() The highlight kind, default is `DocumentHighlightKind#Text`.

getRange	back to summary
public Range getRange() The range this highlight applies to. Annotations @NonNull

getRange

back to summary

public Range getRange()

The range this highlight applies to.

Annotations

@NonNull

hashCode back to summary

hashCode	back 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

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

setKind	back to summary
public void setKind(final DocumentHighlightKind kind) The highlight kind, default is `DocumentHighlightKind#Text`.

setRange	back to summary
public void setRange(final Range range) The range this highlight applies to.

toString back to summary

toString	back 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

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

public Class DocumentHighlight

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail