Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.ParameterInformation

Modifier and Type	Field and Description
private Either<String, MarkupContent>	documentation The human-readable doc-comment of this signature.
private Either<String, Tuple.Two<Integer, Integer>>	label The label of this parameter information.

Access	Constructor and Description
public	ParameterInformation()
public	ParameterInformation(final String label)
public	ParameterInformation(final String label, final String documentation)
public	ParameterInformation(final String label, final MarkupContent documentation)

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 Either<String, MarkupContent>	getDocumentation() The human-readable doc-comment of this signature.
public Either<String, Tuple.Two<Integer, Integer>>	getLabel() The label of this parameter information.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setDocumentation(final Either<String, MarkupContent> documentation) The human-readable doc-comment of this signature.
public void	setDocumentation(final String documentation)
public void	setDocumentation(final MarkupContent documentation)
public void	setLabel(final Either<String, Tuple.Two<Integer, Integer>> label) The label of this parameter information.
public void	setLabel(final String label)
public void	setLabel(final Tuple.Two<Integer, Integer> label)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

documentation	back to summary
private Either<String, MarkupContent> documentation The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

label back to summary

label	back to summary
private Either<String, Tuple.Two<Integer, Integer>> label The label of this parameter information. Either a string or an inclusive start and exclusive end offsets within its containing signature label (see `SignatureInformation#label`). The offsets are based on a UTF-16 string representation as `Position` and `Range` does. Note a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the `SignatureInformation#label`. Annotations @NonNull

private Either<String, Tuple.Two<Integer, Integer>> label

The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing signature label (see SignatureInformation#label). The offsets are based on a UTF-16 string representation as Position and Range does.

Note

a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation#label.

Annotations

@NonNull

Constructor Detail

ParameterInformation	back to summary
public ParameterInformation()

ParameterInformation	back to summary
public ParameterInformation(final String label)

ParameterInformation	back to summary
public ParameterInformation(final String label, final String documentation)

ParameterInformation	back to summary
public ParameterInformation(final String label, final MarkupContent documentation)

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

getDocumentation	back to summary
public Either<String, MarkupContent> getDocumentation() The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

getLabel back to summary

getLabel	back to summary
public Either<String, Tuple.Two<Integer, Integer>> getLabel() The label of this parameter information. Either a string or an inclusive start and exclusive end offsets within its containing signature label (see `SignatureInformation#label`). The offsets are based on a UTF-16 string representation as `Position` and `Range` does. Note a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the `SignatureInformation#label`. Annotations @NonNull

public Either<String, Tuple.Two<Integer, Integer>> getLabel()

The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing signature label (see SignatureInformation#label). The offsets are based on a UTF-16 string representation as Position and Range does.

Note

a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation#label.

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

setDocumentation	back to summary
public void setDocumentation(final Either<String, MarkupContent> documentation) The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

setDocumentation	back to summary
public void setDocumentation(final String documentation)

setDocumentation	back to summary
public void setDocumentation(final MarkupContent documentation)

setLabel back to summary

setLabel	back to summary
public void setLabel(final Either<String, Tuple.Two<Integer, Integer>> label) The label of this parameter information. Either a string or an inclusive start and exclusive end offsets within its containing signature label (see `SignatureInformation#label`). The offsets are based on a UTF-16 string representation as `Position` and `Range` does. Note a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the `SignatureInformation#label`.

public void setLabel(final Either<String, Tuple.Two<Integer, Integer>> label)

The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing signature label (see SignatureInformation#label). The offsets are based on a UTF-16 string representation as Position and Range does.

Note

a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation#label.

setLabel	back to summary
public void setLabel(final String label)

setLabel	back to summary
public void setLabel(final Tuple.Two<Integer, Integer> label)

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 ParameterInformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail