Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class CodeLens

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
com.google.gson.annotations.JsonAdapter, org.eclipse.lsp4j.jsonrpc.json.adapters.JsonElementTypeAdapter, org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

A code lens represents a command that should be shown along with source text, like the number of references, a way to run tests, etc.

A code lens is unresolved when no command is associated to it. For performance reasons the creation of a code lens and resolving should be done to two stages.

Field Summary

Modifier and TypeField and Description
private Command
command

The command this code lens represents.

private Object
data

A data entry field that is preserved on a code lens item between a code lens and a code lens resolve request.

private Range
range

The range in which this code lens is valid.

Constructor Summary

AccessConstructor and Description
public
public
CodeLens(final Range range)

public
CodeLens(final Range range, final Command command, final Object data)

Method Summary

Modifier and TypeMethod 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()

The command this code lens represents.

public Object
getData()

A data entry field that is preserved on a code lens item between a code lens and a code lens resolve request.

public Range
getRange()

The range in which this code lens is valid.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setCommand(final Command command)

The command this code lens represents.

public void
setData(final Object data)

A data entry field that is preserved on a code lens item between a code lens and a code lens resolve request.

public void
setRange(final Range range)

The range in which this code lens is valid.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

commandback to summary
private Command command

The command this code lens represents.

databack to summary
private Object data

A data entry field that is preserved on a code lens item between a code lens and a code lens resolve request.

Annotations
@JsonAdapter:Factory
rangeback to summary
private Range range

The range in which this code lens is valid. Should only span a single line.

Annotations
@NonNull

Constructor Detail

CodeLensback to summary
public CodeLens()
CodeLensback to summary
public CodeLens(final Range range)
CodeLensback to summary
public CodeLens(final Range range, final Command command, final Object data)

Method Detail

equalsback 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
getCommandback to summary
public Command getCommand()

The command this code lens represents.

getDataback to summary
public Object getData()

A data entry field that is preserved on a code lens item between a code lens and a code lens resolve request.

getRangeback to summary
public Range getRange()

The range in which this code lens is valid. Should only span a single line.

Annotations
@NonNull
hashCodeback 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
setCommandback to summary
public void setCommand(final Command command)

The command this code lens represents.

setDataback to summary
public void setData(final Object data)

A data entry field that is preserved on a code lens item between a code lens and a code lens resolve request.

setRangeback to summary
public void setRange(final Range range)

The range in which this code lens is valid. Should only span a single line.

toStringback 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