Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.DocumentLink

Modifier and Type	Field and Description
private Object	data A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
private Range	range The range this link applies to.
private String	target The uri this link points to.
private String	tooltip The tooltip text when you hover over this link.

Access	Constructor and Description
public	DocumentLink()
public	DocumentLink(final Range range)
public	DocumentLink(final Range range, final String target)
public	DocumentLink(final Range range, final String target, final Object data)
public	DocumentLink(final Range range, final String target, final Object data, final String tooltip)

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 Object	getData() A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
public Range	getRange() The range this link applies to.
public String	getTarget() The uri this link points to.
public String	getTooltip() The tooltip text when you hover over this link.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setData(final Object data) A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
public void	setRange(final Range range) The range this link applies to.
public void	setTarget(final String target) The uri this link points to.
public void	setTooltip(final String tooltip) The tooltip text when you hover over 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

data	back to summary
private Object data A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest. Since 3.8.0 Annotations @JsonAdapter:Factory

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

target	back to summary
private String target The uri this link points to. If missing a resolve request is sent later.

tooltip	back to summary
private String tooltip The tooltip text when you hover over this link. If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, user settings, and localization. Since 3.15.0

DocumentLink	back to summary
public DocumentLink()

DocumentLink	back to summary
public DocumentLink(final Range range)

DocumentLink	back to summary
public DocumentLink(final Range range, final String target)

DocumentLink	back to summary
public DocumentLink(final Range range, final String target, final Object data)

DocumentLink	back to summary
public DocumentLink(final Range range, final String target, final Object data, final String tooltip)

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

getData	back to summary
public Object getData() A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest. Since 3.8.0

getData

back to summary

public Object getData()

A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.

Since 3.8.0

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

getRange

back to summary

public Range getRange()

The range this link applies to.

Annotations

@NonNull

getTarget	back to summary
public String getTarget() The uri this link points to. If missing a resolve request is sent later.

getTooltip	back to summary
public String getTooltip() The tooltip text when you hover over this link. If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, user settings, and localization. Since 3.15.0

getTooltip

back to summary

public String getTooltip()

The tooltip text when you hover over this link.

If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, user settings, and localization.

Since 3.15.0

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

setData	back to summary
public void setData(final Object data) A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest. Since 3.8.0

setData

back to summary

public void setData(final Object data)

A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.

Since 3.8.0

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

setTarget	back to summary
public void setTarget(final String target) The uri this link points to. If missing a resolve request is sent later.

setTooltip	back to summary
public void setTooltip(final String tooltip) The tooltip text when you hover over this link. If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, user settings, and localization. Since 3.15.0

setTooltip

back to summary

public void setTooltip(final String tooltip)

The tooltip text when you hover over this link.

Since 3.15.0

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 DocumentLink

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail