Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.PublishDiagnosticsCapabilities

Modifier and Type	Field and Description
private Boolean	codeDescriptionSupport Client supports a codeDescription property Since 3.16.0
private Boolean	dataSupport Whether code action supports the `Diagnostic#data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.
private Boolean	relatedInformation Whether the client accepts diagnostics with related information.
private Either<Boolean, DiagnosticsTagSupport>	tagSupport Client supports the tag property to provide meta data about a diagnostic.
private Boolean	versionSupport Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter.

Access	Constructor and Description
public	PublishDiagnosticsCapabilities()
public	PublishDiagnosticsCapabilities(final Boolean relatedInformation)
public	PublishDiagnosticsCapabilities(final Boolean relatedInformation, final DiagnosticsTagSupport tagSupport)
public	PublishDiagnosticsCapabilities(final Boolean relatedInformation, final DiagnosticsTagSupport tagSupport, final Boolean versionSupport)

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 Boolean	getCodeDescriptionSupport() Client supports a codeDescription property Since 3.16.0
public Boolean	getDataSupport() Whether code action supports the `Diagnostic#data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.
public Boolean	getRelatedInformation() Whether the client accepts diagnostics with related information.
public Either<Boolean, DiagnosticsTagSupport>	getTagSupport() Client supports the tag property to provide meta data about a diagnostic.
public Boolean	getVersionSupport() Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCodeDescriptionSupport(final Boolean codeDescriptionSupport) Client supports a codeDescription property Since 3.16.0
public void	setDataSupport(final Boolean dataSupport) Whether code action supports the `Diagnostic#data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.
public void	setRelatedInformation(final Boolean relatedInformation) Whether the client accepts diagnostics with related information.
public void	setTagSupport(final Either<Boolean, DiagnosticsTagSupport> tagSupport) Client supports the tag property to provide meta data about a diagnostic.
public void	setTagSupport(final Boolean tagSupport)
public void	setTagSupport(final DiagnosticsTagSupport tagSupport)
public void	setVersionSupport(final Boolean versionSupport) Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter.
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

codeDescriptionSupport	back to summary
private Boolean codeDescriptionSupport Client supports a codeDescription property Since 3.16.0

dataSupport	back to summary
private Boolean dataSupport Whether code action supports the `Diagnostic#data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request. Since 3.16.0

relatedInformation	back to summary
private Boolean relatedInformation Whether the client accepts diagnostics with related information.

tagSupport	back to summary
private Either<Boolean, DiagnosticsTagSupport> tagSupport Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully. This property had been added and implemented as boolean before it was added to the specification as `DiagnosticsTagSupport`. In order to keep this implementation compatible with intermediate clients (including vscode-language-client < 6.0.0) we add an either type here. Since 3.15

versionSupport	back to summary
private Boolean versionSupport Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter. Since 3.15.0

PublishDiagnosticsCapabilities	back to summary
public PublishDiagnosticsCapabilities()

PublishDiagnosticsCapabilities	back to summary
public PublishDiagnosticsCapabilities(final Boolean relatedInformation)

PublishDiagnosticsCapabilities	back to summary
public PublishDiagnosticsCapabilities(final Boolean relatedInformation, final DiagnosticsTagSupport tagSupport)

PublishDiagnosticsCapabilities	back to summary
public PublishDiagnosticsCapabilities(final Boolean relatedInformation, final DiagnosticsTagSupport tagSupport, final Boolean versionSupport)

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

getCodeDescriptionSupport	back to summary
public Boolean getCodeDescriptionSupport() Client supports a codeDescription property Since 3.16.0

getCodeDescriptionSupport

back to summary

public Boolean getCodeDescriptionSupport()

Client supports a codeDescription property

Since 3.16.0

getDataSupport back to summary

getDataSupport	back to summary
public Boolean getDataSupport() Whether code action supports the `Diagnostic#data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request. Since 3.16.0

public Boolean getDataSupport()

Whether code action supports the Diagnostic#data property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.

Since 3.16.0

getRelatedInformation	back to summary
public Boolean getRelatedInformation() Whether the client accepts diagnostics with related information.

getTagSupport back to summary

getTagSupport	back to summary
public Either<Boolean, DiagnosticsTagSupport> getTagSupport() Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully. This property had been added and implemented as boolean before it was added to the specification as `DiagnosticsTagSupport`. In order to keep this implementation compatible with intermediate clients (including vscode-language-client < 6.0.0) we add an either type here. Since 3.15

public Either<Boolean, DiagnosticsTagSupport> getTagSupport()

Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully.

This property had been added and implemented as boolean before it was added to the specification as DiagnosticsTagSupport. In order to keep this implementation compatible with intermediate clients (including vscode-language-client < 6.0.0) we add an either type here.

Since 3.15

getVersionSupport	back to summary
public Boolean getVersionSupport() Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter. Since 3.15.0

getVersionSupport

back to summary

public Boolean getVersionSupport()

Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter.

Since 3.15.0

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

setCodeDescriptionSupport	back to summary
public void setCodeDescriptionSupport(final Boolean codeDescriptionSupport) Client supports a codeDescription property Since 3.16.0

setCodeDescriptionSupport

back to summary

public void setCodeDescriptionSupport(final Boolean codeDescriptionSupport)

Client supports a codeDescription property

Since 3.16.0

setDataSupport back to summary

setDataSupport	back to summary
public void setDataSupport(final Boolean dataSupport) Whether code action supports the `Diagnostic#data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request. Since 3.16.0

public void setDataSupport(final Boolean dataSupport)

Whether code action supports the Diagnostic#data property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.

Since 3.16.0

setRelatedInformation	back to summary
public void setRelatedInformation(final Boolean relatedInformation) Whether the client accepts diagnostics with related information.

setTagSupport back to summary

setTagSupport	back to summary
public void setTagSupport(final Either<Boolean, DiagnosticsTagSupport> tagSupport) Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully. This property had been added and implemented as boolean before it was added to the specification as `DiagnosticsTagSupport`. In order to keep this implementation compatible with intermediate clients (including vscode-language-client < 6.0.0) we add an either type here. Since 3.15

public void setTagSupport(final Either<Boolean, DiagnosticsTagSupport> tagSupport)

Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully.

Since 3.15

setTagSupport	back to summary
public void setTagSupport(final Boolean tagSupport)

setTagSupport	back to summary
public void setTagSupport(final DiagnosticsTagSupport tagSupport)

setVersionSupport	back to summary
public void setVersionSupport(final Boolean versionSupport) Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter. Since 3.15.0

setVersionSupport

back to summary

public void setVersionSupport(final Boolean versionSupport)

Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter.

Since 3.15.0

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 PublishDiagnosticsCapabilities

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail