Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class SemanticTokensWithRegistrationOptions

extends AbstractTextDocumentRegistrationAndWorkDoneProgressOptions
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
java.util.List, org.eclipse.lsp4j.jsonrpc.messages.Either, org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

Since 3.16.0

Field Summary

Modifier and TypeField and Description
private Either<Boolean, SemanticTokensServerFull>
full

Server supports providing semantic tokens for a full document.

private String
id

The id used to register the request.

private SemanticTokensLegend
legend

The legend used by the server

private Either<Boolean, Object>
range

Server supports providing semantic tokens for a specific range of a document.

Constructor Summary

AccessConstructor and Description
public
public
public
public
public
public
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.equals.

Indicates whether some other object is "equal to" this one.

public Either<Boolean, SemanticTokensServerFull>
getFull()

Server supports providing semantic tokens for a full document.

public String
getId()

The id used to register the request.

public SemanticTokensLegend
getLegend()

The legend used by the server

public Either<Boolean, Object>
getRange()

Server supports providing semantic tokens for a specific range of a document.

public int
public void
setFull(final Either<Boolean, SemanticTokensServerFull> full)

Server supports providing semantic tokens for a full document.

public void
setFull(final Boolean full)

public void
public void
setId(final String id)

The id used to register the request.

public void
setLegend(final SemanticTokensLegend legend)

The legend used by the server

public void
setRange(final Either<Boolean, Object> range)

Server supports providing semantic tokens for a specific range of a document.

public void
setRange(final Boolean range)

public void
setRange(final Object range)

public String
Inherited from org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions:
getWorkDoneProgresssetWorkDoneProgress

Field Detail

fullback to summary
private Either<Boolean, SemanticTokensServerFull> full

Server supports providing semantic tokens for a full document.

idback to summary
private String id

The id used to register the request. The id can be used to deregister the request again. See also Registration#id.

legendback to summary
private SemanticTokensLegend legend

The legend used by the server

Annotations
@NonNull
rangeback to summary
private Either<Boolean, Object> range

Server supports providing semantic tokens for a specific range of a document.

Constructor Detail

SemanticTokensWithRegistrationOptionsback to summary
public SemanticTokensWithRegistrationOptions()
SemanticTokensWithRegistrationOptionsback to summary
public SemanticTokensWithRegistrationOptions(final SemanticTokensLegend legend)
SemanticTokensWithRegistrationOptionsback to summary
public SemanticTokensWithRegistrationOptions(final SemanticTokensLegend legend, final Boolean full)
SemanticTokensWithRegistrationOptionsback to summary
public SemanticTokensWithRegistrationOptions(final SemanticTokensLegend legend, final SemanticTokensServerFull full)
SemanticTokensWithRegistrationOptionsback to summary
public SemanticTokensWithRegistrationOptions(final SemanticTokensLegend legend, final Boolean full, final Boolean range)
SemanticTokensWithRegistrationOptionsback to summary
public SemanticTokensWithRegistrationOptions(final SemanticTokensLegend legend, final SemanticTokensServerFull full, final Boolean range)
SemanticTokensWithRegistrationOptionsback to summary
public SemanticTokensWithRegistrationOptions(final SemanticTokensLegend legend, final SemanticTokensServerFull full, final Boolean range, final List<DocumentFilter> documentSelector)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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
getFullback to summary
public Either<Boolean, SemanticTokensServerFull> getFull()

Server supports providing semantic tokens for a full document.

getIdback to summary
public String getId()

The id used to register the request. The id can be used to deregister the request again. See also Registration#id.

getLegendback to summary
public SemanticTokensLegend getLegend()

The legend used by the server

Annotations
@NonNull
getRangeback to summary
public Either<Boolean, Object> getRange()

Server supports providing semantic tokens for a specific range of a document.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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
setFullback to summary
public void setFull(final Either<Boolean, SemanticTokensServerFull> full)

Server supports providing semantic tokens for a full document.

setFullback to summary
public void setFull(final Boolean full)
setFullback to summary
public void setFull(final SemanticTokensServerFull full)
setIdback to summary
public void setId(final String id)

The id used to register the request. The id can be used to deregister the request again. See also Registration#id.

setLegendback to summary
public void setLegend(final SemanticTokensLegend legend)

The legend used by the server

setRangeback to summary
public void setRange(final Either<Boolean, Object> range)

Server supports providing semantic tokens for a specific range of a document.

setRangeback to summary
public void setRange(final Boolean range)
setRangeback to summary
public void setRange(final Object range)
toStringback to summary
public String toString()

Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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