Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.InlayHintLabelPart

Modifier and Type	Field and Description
private Command	command An optional command for this label part.
private Location	location An optional source code location that represents this label part.
private Either<String, MarkupContent>	tooltip The tooltip text when you hover over this label part.
private String	value The value of this label part.

Access	Constructor and Description
public	InlayHintLabelPart()
public	InlayHintLabelPart(final String value)

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 Command	getCommand() An optional command for this label part.
public Location	getLocation() An optional source code location that represents this label part.
public Either<String, MarkupContent>	getTooltip() The tooltip text when you hover over this label part.
public String	getValue() The value of this label part.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCommand(final Command command) An optional command for this label part.
public void	setLocation(final Location location) An optional source code location that represents this label part.
public void	setTooltip(final Either<String, MarkupContent> tooltip) The tooltip text when you hover over this label part.
public void	setTooltip(final String tooltip)
public void	setTooltip(final MarkupContent tooltip)
public void	setValue(final String value) The value of this label part.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

command back to summary

command	back to summary
private Command command An optional command for this label part. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

private Command command

An optional command for this label part.

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

location back to summary

location	back to summary
private Location location An optional source code location that represents this label part. The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

private Location location

An optional source code location that represents this label part.

The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands.

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

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

value	back to summary
private String value The value of this label part. Annotations @NonNull

Constructor Detail

InlayHintLabelPart	back to summary
public InlayHintLabelPart()

InlayHintLabelPart	back to summary
public InlayHintLabelPart(final String value)

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

getCommand back to summary

getCommand	back to summary
public Command getCommand() An optional command for this label part. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public Command getCommand()

An optional command for this label part.

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

getLocation back to summary

getLocation	back to summary
public Location getLocation() An optional source code location that represents this label part. The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public Location getLocation()

An optional source code location that represents this label part.

The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands.

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

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

getValue	back to summary
public String getValue() The value of this label part. Annotations @NonNull

getValue

back to summary

public String getValue()

The value of this label part.

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

setCommand back to summary

setCommand	back to summary
public void setCommand(final Command command) An optional command for this label part. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public void setCommand(final Command command)

An optional command for this label part.

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

setLocation back to summary

setLocation	back to summary
public void setLocation(final Location location) An optional source code location that represents this label part. The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands. Depending on the client capability `InlayHintCapabilities#resolveSupport` clients might resolve this property late using the resolve request.

public void setLocation(final Location location)

An optional source code location that represents this label part.

The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands.

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 Either<String, MarkupContent> tooltip) The tooltip text when you hover over this label part. 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)

setValue	back to summary
public void setValue(final String value) The value of this label part.

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 InlayHintLabelPart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail