Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.ColorPresentation

Modifier and Type	Field and Description
private List<TextEdit>	additionalTextEdits An optional array of additional text edits that are applied when selecting this color presentation.
private String	label The label of this color presentation.
private TextEdit	textEdit An edit which is applied to a document when selecting this presentation for the color.

Access	Constructor and Description
public	ColorPresentation()
public	ColorPresentation(final String label)
public	ColorPresentation(final String label, final TextEdit textEdit)
public	ColorPresentation(final String label, final TextEdit textEdit, final List<TextEdit> additionalTextEdits)

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 List<TextEdit>	getAdditionalTextEdits() An optional array of additional text edits that are applied when selecting this color presentation.
public String	getLabel() The label of this color presentation.
public TextEdit	getTextEdit() An edit which is applied to a document when selecting this presentation for the color.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setAdditionalTextEdits(final List<TextEdit> additionalTextEdits) An optional array of additional text edits that are applied when selecting this color presentation.
public void	setLabel(final String label) The label of this color presentation.
public void	setTextEdit(final TextEdit textEdit) An edit which is applied to a document when selecting this presentation for the color.
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

additionalTextEdits	back to summary
private List<TextEdit> additionalTextEdits An optional array of additional text edits that are applied when selecting this color presentation. Edits must not overlap with the main edit nor with themselves.

label	back to summary
private String label The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation. Annotations @NonNull

textEdit	back to summary
private TextEdit textEdit An edit which is applied to a document when selecting this presentation for the color. When `null` the label is used.

ColorPresentation	back to summary
public ColorPresentation()

ColorPresentation	back to summary
public ColorPresentation(final String label)

ColorPresentation	back to summary
public ColorPresentation(final String label, final TextEdit textEdit)

ColorPresentation	back to summary
public ColorPresentation(final String label, final TextEdit textEdit, final List<TextEdit> additionalTextEdits)

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

getAdditionalTextEdits	back to summary
public List<TextEdit> getAdditionalTextEdits() An optional array of additional text edits that are applied when selecting this color presentation. Edits must not overlap with the main edit nor with themselves.

getLabel	back to summary
public String getLabel() The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation. Annotations @NonNull

getLabel

back to summary

public String getLabel()

The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.

Annotations

@NonNull

getTextEdit	back to summary
public TextEdit getTextEdit() An edit which is applied to a document when selecting this presentation for the color. When `null` the label is used.

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

setAdditionalTextEdits	back to summary
public void setAdditionalTextEdits(final List<TextEdit> additionalTextEdits) An optional array of additional text edits that are applied when selecting this color presentation. Edits must not overlap with the main edit nor with themselves.

setLabel	back to summary
public void setLabel(final String label) The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.

setTextEdit	back to summary
public void setTextEdit(final TextEdit textEdit) An edit which is applied to a document when selecting this presentation for the color. When `null` the label is used.

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 ColorPresentation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail