Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class ColorPresentationParams

extends WorkDoneProgressAndPartialResultParams
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

The color presentation request is sent from the client to the server to obtain a list of presentations for a color value at a given location.

Since 3.6.0

Field Summary

Modifier and TypeField and Description
private Color
color

The color information to request presentations for.

private Range
range

The range where the color would be inserted.

private TextDocumentIdentifier
textDocument

The text document.

Constructor Summary

AccessConstructor and Description
public
public
ColorPresentationParams(final TextDocumentIdentifier textDocument, final Color color, final Range range)

Method Summary

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

Overrides org.eclipse.lsp4j.WorkDoneProgressAndPartialResultParams.equals.

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

public Color
getColor()

The color information to request presentations for.

public Range
getRange()

The range where the color would be inserted.

public TextDocumentIdentifier
getTextDocument()

The text document.

public int
hashCode()

Overrides org.eclipse.lsp4j.WorkDoneProgressAndPartialResultParams.hashCode.

Returns a hash code value for this object.

public void
setColor(final Color color)

The color information to request presentations for.

public void
setRange(final Range range)

The range where the color would be inserted.

public void
setTextDocument(final TextDocumentIdentifier textDocument)

The text document.

public String
toString()

Overrides org.eclipse.lsp4j.WorkDoneProgressAndPartialResultParams.toString.

Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.WorkDoneProgressAndPartialResultParams:
getPartialResultTokengetWorkDoneTokensetPartialResultTokensetPartialResultTokensetPartialResultTokensetWorkDoneTokensetWorkDoneTokensetWorkDoneToken

Field Detail

colorback to summary
private Color color

The color information to request presentations for.

Annotations
@NonNull
rangeback to summary
private Range range

The range where the color would be inserted. Serves as a context.

Annotations
@NonNull
textDocumentback to summary
private TextDocumentIdentifier textDocument

The text document.

Annotations
@NonNull

Constructor Detail

ColorPresentationParamsback to summary
public ColorPresentationParams()
ColorPresentationParamsback to summary
public ColorPresentationParams(final TextDocumentIdentifier textDocument, final Color color, final Range range)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.WorkDoneProgressAndPartialResultParams.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
getColorback to summary
public Color getColor()

The color information to request presentations for.

Annotations
@NonNull
getRangeback to summary
public Range getRange()

The range where the color would be inserted. Serves as a context.

Annotations
@NonNull
getTextDocumentback to summary
public TextDocumentIdentifier getTextDocument()

The text document.

Annotations
@NonNull
hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.WorkDoneProgressAndPartialResultParams.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
setColorback to summary
public void setColor(final Color color)

The color information to request presentations for.

setRangeback to summary
public void setRange(final Range range)

The range where the color would be inserted. Serves as a context.

setTextDocumentback to summary
public void setTextDocument(final TextDocumentIdentifier textDocument)

The text document.

toStringback to summary
public String toString()

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