Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.DiagnosticRegistrationOptions

Modifier and Type	Field and Description
private String	id The id used to register the request.
private String	identifier An optional identifier under which the diagnostics are managed by the client.
private boolean	interFileDependencies Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file.
private boolean	workspaceDiagnostics The server provides support for workspace diagnostics as well.

Access	Constructor and Description
public	DiagnosticRegistrationOptions()
public	DiagnosticRegistrationOptions(final String id)
public	DiagnosticRegistrationOptions(final boolean interFileDependencies, final boolean workspaceDiagnostics)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.equals. Indicates whether some other object is "equal to" this one.
public String	getId() The id used to register the request.
public String	getIdentifier() An optional identifier under which the diagnostics are managed by the client.
public int	hashCode() Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.hashCode. Returns a hash code value for this object.
public boolean	isInterFileDependencies() Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file.
public boolean	isWorkspaceDiagnostics() The server provides support for workspace diagnostics as well.
public void	setId(final String id) The id used to register the request.
public void	setIdentifier(final String identifier) An optional identifier under which the diagnostics are managed by the client.
public void	setInterFileDependencies(final boolean interFileDependencies) Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file.
public void	setWorkspaceDiagnostics(final boolean workspaceDiagnostics) The server provides support for workspace diagnostics as well.
public String	toString() Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.toString. Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions:: getWorkDoneProgress setWorkDoneProgress

id	back to summary
private String id The id used to register the request. The id can be used to deregister the request again. See also `Registration#id`.

identifier	back to summary
private String identifier An optional identifier under which the diagnostics are managed by the client.

interFileDependencies	back to summary
private boolean interFileDependencies Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file. Inter file dependencies are common for most programming languages and typically uncommon for linters.

workspaceDiagnostics	back to summary
private boolean workspaceDiagnostics The server provides support for workspace diagnostics as well.

DiagnosticRegistrationOptions	back to summary
public DiagnosticRegistrationOptions()

DiagnosticRegistrationOptions	back to summary
public DiagnosticRegistrationOptions(final String id)

DiagnosticRegistrationOptions	back to summary
public DiagnosticRegistrationOptions(final boolean interFileDependencies, final boolean workspaceDiagnostics)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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 org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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

getId	back to summary
public String getId() The id used to register the request. The id can be used to deregister the request again. See also `Registration#id`.

getIdentifier	back to summary
public String getIdentifier() An optional identifier under which the diagnostics are managed by the client.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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 org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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

isInterFileDependencies	back to summary
public boolean isInterFileDependencies() Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file. Inter file dependencies are common for most programming languages and typically uncommon for linters.

isWorkspaceDiagnostics	back to summary
public boolean isWorkspaceDiagnostics() The server provides support for workspace diagnostics as well.

setId	back to summary
public void setId(final String id) The id used to register the request. The id can be used to deregister the request again. See also `Registration#id`.

setIdentifier	back to summary
public void setIdentifier(final String identifier) An optional identifier under which the diagnostics are managed by the client.

setInterFileDependencies	back to summary
public void setInterFileDependencies(final boolean interFileDependencies) Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file. Inter file dependencies are common for most programming languages and typically uncommon for linters.

setWorkspaceDiagnostics	back to summary
public void setWorkspaceDiagnostics(final boolean workspaceDiagnostics) The server provides support for workspace diagnostics as well.

toString back to summary

toString	back to summary
public String toString() Overrides org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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 org.eclipse.lsp4j.AbstractTextDocumentRegistrationAndWorkDoneProgressOptions.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 DiagnosticRegistrationOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail