Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.DocumentFormattingParams

Modifier and Type	Field and Description
private FormattingOptions	options The format options
private TextDocumentIdentifier	textDocument The document to format.
private Either<String, Integer>	workDoneToken An optional token that a server can use to report work done progress.

Access	Constructor and Description
public	DocumentFormattingParams()
public	DocumentFormattingParams(final TextDocumentIdentifier textDocument, final FormattingOptions options)

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 FormattingOptions	getOptions() The format options
public TextDocumentIdentifier	getTextDocument() The document to format.
public Either<String, Integer>	getWorkDoneToken() Implements org.eclipse.lsp4j.WorkDoneProgressParams.getWorkDoneToken. An optional token that a server can use to report work done progress.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setOptions(final FormattingOptions options) The format options
public void	setTextDocument(final TextDocumentIdentifier textDocument) The document to format.
public void	setWorkDoneToken(final Either<String, Integer> workDoneToken) Implements org.eclipse.lsp4j.WorkDoneProgressParams.setWorkDoneToken. An optional token that a server can use to report work done progress.
public void	setWorkDoneToken(final String workDoneToken)
public void	setWorkDoneToken(final Integer workDoneToken)
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

options	back to summary
private FormattingOptions options The format options Annotations @NonNull

textDocument	back to summary
private TextDocumentIdentifier textDocument The document to format. Annotations @NonNull

workDoneToken	back to summary
private Either<String, Integer> workDoneToken An optional token that a server can use to report work done progress.

DocumentFormattingParams	back to summary
public DocumentFormattingParams()

DocumentFormattingParams	back to summary
public DocumentFormattingParams(final TextDocumentIdentifier textDocument, final FormattingOptions options)

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

getOptions	back to summary
public FormattingOptions getOptions() The format options Annotations @NonNull

getOptions

back to summary

public FormattingOptions getOptions()

The format options

Annotations

@NonNull

getTextDocument	back to summary
public TextDocumentIdentifier getTextDocument() The document to format. Annotations @NonNull

getTextDocument

back to summary

public TextDocumentIdentifier getTextDocument()

The document to format.

Annotations

@NonNull

getWorkDoneToken	back to summary
public Either<String, Integer> getWorkDoneToken() Implements org.eclipse.lsp4j.WorkDoneProgressParams.getWorkDoneToken. An optional token that a server can use to report work done progress. Annotations @Override

getWorkDoneToken

back to summary

public Either<String, Integer> getWorkDoneToken()

Implements org.eclipse.lsp4j.WorkDoneProgressParams.getWorkDoneToken.

An optional token that a server can use to report work done progress.

Annotations

@Override

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

setOptions	back to summary
public void setOptions(final FormattingOptions options) The format options

setTextDocument	back to summary
public void setTextDocument(final TextDocumentIdentifier textDocument) The document to format.

setWorkDoneToken	back to summary
public void setWorkDoneToken(final Either<String, Integer> workDoneToken) Implements org.eclipse.lsp4j.WorkDoneProgressParams.setWorkDoneToken. An optional token that a server can use to report work done progress.

setWorkDoneToken

back to summary

public void setWorkDoneToken(final Either<String, Integer> workDoneToken)

Implements org.eclipse.lsp4j.WorkDoneProgressParams.setWorkDoneToken.

An optional token that a server can use to report work done progress.

setWorkDoneToken	back to summary
public void setWorkDoneToken(final String workDoneToken)

setWorkDoneToken	back to summary
public void setWorkDoneToken(final Integer workDoneToken)

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 DocumentFormattingParams

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail