Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.LocationLink

Modifier and Type	Field and Description
private Range	originSelectionRange Span of the origin of this link.
private Range	targetRange The full target range of this link.
private Range	targetSelectionRange The range that should be selected and revealed when this link is being followed, e.g the name of a function.
private String	targetUri The target resource identifier of this link.

Access	Constructor and Description
public	LocationLink()
public	LocationLink(final String targetUri, final Range targetRange, final Range targetSelectionRange)
public	LocationLink(final String targetUri, final Range targetRange, final Range targetSelectionRange, final Range originSelectionRange)

Method Summary

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 Range	getOriginSelectionRange() Span of the origin of this link.
public Range	getTargetRange() The full target range of this link.
public Range	getTargetSelectionRange() The range that should be selected and revealed when this link is being followed, e.g the name of a function.
public String	getTargetUri() The target resource identifier of this link.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setOriginSelectionRange(final Range originSelectionRange) Span of the origin of this link.
public void	setTargetRange(final Range targetRange) The full target range of this link.
public void	setTargetSelectionRange(final Range targetSelectionRange) The range that should be selected and revealed when this link is being followed, e.g the name of a function.
public void	setTargetUri(final String targetUri) The target resource identifier of this link.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

originSelectionRange	back to summary
private Range originSelectionRange Span of the origin of this link. Used as the underlined span for mouse interaction. Defaults to the word range at the mouse position.

targetRange	back to summary
private Range targetRange The full target range of this link. If the target for example is a symbol then target range is the range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to highlight the range in the editor. Annotations @NonNull

targetSelectionRange	back to summary
private Range targetSelectionRange The range that should be selected and revealed when this link is being followed, e.g the name of a function. Must be contained by the `targetRange`. See also `DocumentSymbol#range` Annotations @NonNull

targetUri	back to summary
private String targetUri The target resource identifier of this link. Annotations @NonNull

LocationLink	back to summary
public LocationLink()

LocationLink	back to summary
public LocationLink(final String targetUri, final Range targetRange, final Range targetSelectionRange)

LocationLink	back to summary
public LocationLink(final String targetUri, final Range targetRange, final Range targetSelectionRange, final Range originSelectionRange)

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

getOriginSelectionRange	back to summary
public Range getOriginSelectionRange() Span of the origin of this link. Used as the underlined span for mouse interaction. Defaults to the word range at the mouse position.

getOriginSelectionRange

back to summary

public Range getOriginSelectionRange()

Span of the origin of this link.

Used as the underlined span for mouse interaction. Defaults to the word range at the mouse position.

getTargetRange	back to summary
public Range getTargetRange() The full target range of this link. If the target for example is a symbol then target range is the range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to highlight the range in the editor. Annotations @NonNull

getTargetRange

back to summary

public Range getTargetRange()

The full target range of this link. If the target for example is a symbol then target range is the range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to highlight the range in the editor.

Annotations

@NonNull

getTargetSelectionRange back to summary

getTargetSelectionRange	back to summary
public Range getTargetSelectionRange() The range that should be selected and revealed when this link is being followed, e.g the name of a function. Must be contained by the `targetRange`. See also `DocumentSymbol#range` Annotations @NonNull

public Range getTargetSelectionRange()

The range that should be selected and revealed when this link is being followed, e.g the name of a function. Must be contained by the targetRange. See also DocumentSymbol#range

Annotations

@NonNull

getTargetUri	back to summary
public String getTargetUri() The target resource identifier of this link. Annotations @NonNull

getTargetUri

back to summary

public String getTargetUri()

The target resource identifier of this link.

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

setOriginSelectionRange	back to summary
public void setOriginSelectionRange(final Range originSelectionRange) Span of the origin of this link. Used as the underlined span for mouse interaction. Defaults to the word range at the mouse position.

setOriginSelectionRange

back to summary

public void setOriginSelectionRange(final Range originSelectionRange)

Span of the origin of this link.

Used as the underlined span for mouse interaction. Defaults to the word range at the mouse position.

setTargetRange	back to summary
public void setTargetRange(final Range targetRange) The full target range of this link. If the target for example is a symbol then target range is the range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to highlight the range in the editor.

setTargetSelectionRange	back to summary
public void setTargetSelectionRange(final Range targetSelectionRange) The range that should be selected and revealed when this link is being followed, e.g the name of a function. Must be contained by the `targetRange`. See also `DocumentSymbol#range`

setTargetUri	back to summary
public void setTargetUri(final String targetUri) The target resource identifier of this link.

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 LocationLink

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail