Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.InlayHint · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Object	data A data entry field that is preserved on a inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request.
private InlayHintKind	kind The kind of this hint.
private Either<String, List<InlayHintLabelPart>>	label The label of this hint.
private Boolean	paddingLeft Render padding before the hint.
private Boolean	paddingRight Render padding after the hint.
private Position	position The position of this hint.
private List<TextEdit>	textEdits Optional text edits that are performed when accepting this inlay hint.
private Either<String, MarkupContent>	tooltip The tooltip text when you hover over this item.

Access	Constructor and Description
public	InlayHint()
public	InlayHint(final Position position, final Either<String, List<InlayHintLabelPart>> label)

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 inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request.
public InlayHintKind	getKind() The kind of this hint.
public Either<String, List<InlayHintLabelPart>>	getLabel() The label of this hint.
public Boolean	getPaddingLeft() Render padding before the hint.
public Boolean	getPaddingRight() Render padding after the hint.
public Position	getPosition() The position of this hint.
public List<TextEdit>	getTextEdits() Optional text edits that are performed when accepting this inlay hint.
public Either<String, MarkupContent>	getTooltip() The tooltip text when you hover over this item.
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 inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request.
public void	setKind(final InlayHintKind kind) The kind of this hint.
public void	setLabel(final Either<String, List<InlayHintLabelPart>> label) The label of this hint.
public void	setLabel(final String label)
public void	setLabel(final List<InlayHintLabelPart> label)
public void	setPaddingLeft(final Boolean paddingLeft) Render padding before the hint.
public void	setPaddingRight(final Boolean paddingRight) Render padding after the hint.
public void	setPosition(final Position position) The position of this hint.
public void	setTextEdits(final List<TextEdit> textEdits) Optional text edits that are performed when accepting this inlay hint.
public void	setTooltip(final Either<String, MarkupContent> tooltip) The tooltip text when you hover over this item.
public void	setTooltip(final String tooltip)
public void	setTooltip(final MarkupContent tooltip)
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

Field Detail

data	back to summary
private Object data A data entry field that is preserved on a inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request. Annotations @JsonAdapter:Factory

kind	back to summary
private InlayHintKind kind The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.

label back to summary

label	back to summary
private Either<String, List<InlayHintLabelPart>> label The label of this hint. A human readable string or an array of `InlayHintLabelPart` label parts. Note that neither the string nor the label part can be empty. Annotations @NonNull

private Either<String, List<InlayHintLabelPart>> label

The label of this hint. A human readable string or an array of InlayHintLabelPart label parts.

*Note* that neither the string nor the label part can be empty.

Annotations

@NonNull

paddingLeft	back to summary
private Boolean paddingLeft Render padding before the hint. Note Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

paddingRight	back to summary
private Boolean paddingRight Render padding after the hint. Note Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

position	back to summary
private Position position The position of this hint. Annotations @NonNull

textEdits back to summary

textEdits	back to summary
private List<TextEdit> textEdits Optional text edits that are performed when accepting this inlay hint. Note that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

private List<TextEdit> textEdits

Optional text edits that are performed when accepting this inlay hint.

*Note* that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete.

Depending on the client capability InlayHintCapabilities#resolveSupport clients might resolve this property late using the resolve request.

tooltip back to summary

tooltip	back to summary
private Either<String, MarkupContent> tooltip The tooltip text when you hover over this item. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

private Either<String, MarkupContent> tooltip

The tooltip text when you hover over this item.

Depending on the client capability InlayHintCapabilities#resolveSupport clients might resolve this property late using the resolve request.

Constructor Detail

InlayHint	back to summary
public InlayHint()

InlayHint	back to summary
public InlayHint(final Position position, final Either<String, List<InlayHintLabelPart>> label)

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 inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request.

getKind	back to summary
public InlayHintKind getKind() The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.

getLabel back to summary

getLabel	back to summary
public Either<String, List<InlayHintLabelPart>> getLabel() The label of this hint. A human readable string or an array of `InlayHintLabelPart` label parts. Note that neither the string nor the label part can be empty. Annotations @NonNull

public Either<String, List<InlayHintLabelPart>> getLabel()

The label of this hint. A human readable string or an array of InlayHintLabelPart label parts.

*Note* that neither the string nor the label part can be empty.

Annotations

@NonNull

getPaddingLeft	back to summary
public Boolean getPaddingLeft() Render padding before the hint. Note Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

getPaddingRight	back to summary
public Boolean getPaddingRight() Render padding after the hint. Note Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

getPosition	back to summary
public Position getPosition() The position of this hint. Annotations @NonNull

getPosition

back to summary

public Position getPosition()

The position of this hint.

Annotations

@NonNull

getTextEdits back to summary

getTextEdits	back to summary
public List<TextEdit> getTextEdits() Optional text edits that are performed when accepting this inlay hint. Note that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public List<TextEdit> getTextEdits()

Optional text edits that are performed when accepting this inlay hint.

*Note* that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete.

Depending on the client capability InlayHintCapabilities#resolveSupport clients might resolve this property late using the resolve request.

getTooltip back to summary

getTooltip	back to summary
public Either<String, MarkupContent> getTooltip() The tooltip text when you hover over this item. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public Either<String, MarkupContent> getTooltip()

The tooltip text when you hover over this item.

Depending on the client capability InlayHintCapabilities#resolveSupport clients might resolve this property late using the resolve request.

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 inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request.

setKind	back to summary
public void setKind(final InlayHintKind kind) The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.

setLabel back to summary

setLabel	back to summary
public void setLabel(final Either<String, List<InlayHintLabelPart>> label) The label of this hint. A human readable string or an array of `InlayHintLabelPart` label parts. Note that neither the string nor the label part can be empty.

public void setLabel(final Either<String, List<InlayHintLabelPart>> label)

The label of this hint. A human readable string or an array of InlayHintLabelPart label parts.

*Note* that neither the string nor the label part can be empty.

setLabel	back to summary
public void setLabel(final String label)

setLabel	back to summary
public void setLabel(final List<InlayHintLabelPart> label)

setPaddingLeft	back to summary
public void setPaddingLeft(final Boolean paddingLeft) Render padding before the hint. Note Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

setPaddingRight	back to summary
public void setPaddingRight(final Boolean paddingRight) Render padding after the hint. Note Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

setPosition	back to summary
public void setPosition(final Position position) The position of this hint.

setTextEdits back to summary

setTextEdits	back to summary
public void setTextEdits(final List<TextEdit> textEdits) Optional text edits that are performed when accepting this inlay hint. Note that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public void setTextEdits(final List<TextEdit> textEdits)

Optional text edits that are performed when accepting this inlay hint.

*Note* that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete.

Depending on the client capability InlayHintCapabilities#resolveSupport clients might resolve this property late using the resolve request.

setTooltip back to summary

setTooltip	back to summary
public void setTooltip(final Either<String, MarkupContent> tooltip) The tooltip text when you hover over this item. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public void setTooltip(final Either<String, MarkupContent> tooltip)

The tooltip text when you hover over this item.

Depending on the client capability InlayHintCapabilities#resolveSupport clients might resolve this property late using the resolve request.

setTooltip	back to summary
public void setTooltip(final String tooltip)

setTooltip	back to summary
public void setTooltip(final MarkupContent tooltip)

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 InlayHint

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail