Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.ProgressParams

public Class ProgressParams

The base protocol offers also support to report progress in a generic fashion. This mechanism can be used to report any kind of progress including work done progress (usually used to report progress in the user interface using a progress bar) and partial result progress to support streaming of results. A progress notification has the following properties:

Since 3.15.0

Field Summary

Modifier and Type	Field and Description
private Either<String, Integer>	token The progress token provided by the client or server.
private Either<WorkDoneProgressNotification, Object>	value The progress data.

Access	Constructor and Description
public	ProgressParams()
public	ProgressParams(final Either<String, Integer> token, final Either<WorkDoneProgressNotification, Object> value)

Access

Constructor and Description

public

ProgressParams()

public

ProgressParams(final Either<String, Integer> token, final Either<WorkDoneProgressNotification, Object> value)

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 Either<String, Integer>	getToken() The progress token provided by the client or server.
public Either<WorkDoneProgressNotification, Object>	getValue() The progress data.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setToken(final Either<String, Integer> token) The progress token provided by the client or server.
public void	setToken(final String token)
public void	setToken(final Integer token)
public void	setValue(final Either<WorkDoneProgressNotification, Object> value) The progress data.
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

token	back to summary
private Either<String, Integer> token The progress token provided by the client or server. Annotations @NonNull

token

back to summary

private Either<String, Integer> token

The progress token provided by the client or server.

Annotations

@NonNull

value	back to summary
private Either<WorkDoneProgressNotification, Object> value The progress data. Annotations @NonNull @JsonAdapter:ProgressNotificationAdapter

value

back to summary

private Either<WorkDoneProgressNotification, Object> value

The progress data.

Annotations

@NonNull
@JsonAdapter:ProgressNotificationAdapter

Constructor Detail

ProgressParams	back to summary
public ProgressParams()

ProgressParams	back to summary
public ProgressParams(final Either<String, Integer> token, final Either<WorkDoneProgressNotification, Object> value)

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

getToken	back to summary
public Either<String, Integer> getToken() The progress token provided by the client or server. Annotations @NonNull

getToken

back to summary

public Either<String, Integer> getToken()

The progress token provided by the client or server.

Annotations

@NonNull

getValue	back to summary
public Either<WorkDoneProgressNotification, Object> getValue() The progress data. Annotations @NonNull

getValue

back to summary

public Either<WorkDoneProgressNotification, Object> getValue()

The progress data.

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

setToken	back to summary
public void setToken(final Either<String, Integer> token) The progress token provided by the client or server.

setToken	back to summary
public void setToken(final String token)

setToken	back to summary
public void setToken(final Integer token)

setValue	back to summary
public void setValue(final Either<WorkDoneProgressNotification, Object> value) The progress data.

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 ProgressParams

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail