Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.Diagnostic · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Either<String, Integer>	code The diagnostic's code.
private DiagnosticCodeDescription	codeDescription An optional property to describe the error code.
private Object	data A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request.
private String	message The diagnostic's message.
private Range	range The range at which the message applies
private List<DiagnosticRelatedInformation>	relatedInformation An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.
private DiagnosticSeverity	severity The diagnostic's severity.
private String	source A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.
private List<DiagnosticTag>	tags Additional metadata about the diagnostic.

Access	Constructor and Description
public	Diagnostic()
public	Diagnostic(final Range range, final String message)
public	Diagnostic(final Range range, final String message, final DiagnosticSeverity severity, final String source)
public	Diagnostic(final Range range, final String message, final DiagnosticSeverity severity, final String source, final String code)

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>	getCode() The diagnostic's code.
public DiagnosticCodeDescription	getCodeDescription() An optional property to describe the error code.
public Object	getData() A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request.
public String	getMessage() The diagnostic's message.
public Range	getRange() The range at which the message applies
public List<DiagnosticRelatedInformation>	getRelatedInformation() An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.
public DiagnosticSeverity	getSeverity() The diagnostic's severity.
public String	getSource() A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.
public List<DiagnosticTag>	getTags() Additional metadata about the diagnostic.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCode(final Either<String, Integer> code) The diagnostic's code.
public void	setCode(final String code)
public void	setCode(final Integer code)
public void	setCodeDescription(final DiagnosticCodeDescription codeDescription) An optional property to describe the error code.
public void	setData(final Object data) A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request.
public void	setMessage(final String message) The diagnostic's message.
public void	setRange(final Range range) The range at which the message applies
public void	setRelatedInformation(final List<DiagnosticRelatedInformation> relatedInformation) An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.
public void	setSeverity(final DiagnosticSeverity severity) The diagnostic's severity.
public void	setSource(final String source) A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.
public void	setTags(final List<DiagnosticTag> tags) Additional metadata about the diagnostic.
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

code	back to summary
private Either<String, Integer> code The diagnostic's code. Can be omitted.

codeDescription	back to summary
private DiagnosticCodeDescription codeDescription An optional property to describe the error code. Since 3.16.0

data	back to summary
private Object data A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request. Since 3.16.0 Annotations @JsonAdapter:Factory

message	back to summary
private String message The diagnostic's message. Annotations @NonNull

range	back to summary
private Range range The range at which the message applies Annotations @NonNull

relatedInformation	back to summary
private List<DiagnosticRelatedInformation> relatedInformation An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property. Since 3.7.0

severity	back to summary
private DiagnosticSeverity severity The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

source	back to summary
private String source A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

tags	back to summary
private List<DiagnosticTag> tags Additional metadata about the diagnostic. Since 3.15.0

Diagnostic	back to summary
public Diagnostic()

Diagnostic	back to summary
public Diagnostic(final Range range, final String message)

Diagnostic	back to summary
public Diagnostic(final Range range, final String message, final DiagnosticSeverity severity, final String source)

Diagnostic	back to summary
public Diagnostic(final Range range, final String message, final DiagnosticSeverity severity, final String source, final String code)

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

getCode	back to summary
public Either<String, Integer> getCode() The diagnostic's code. Can be omitted.

getCodeDescription	back to summary
public DiagnosticCodeDescription getCodeDescription() An optional property to describe the error code. Since 3.16.0

getCodeDescription

back to summary

public DiagnosticCodeDescription getCodeDescription()

An optional property to describe the error code.

Since 3.16.0

getData	back to summary
public Object getData() A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request. Since 3.16.0

getData

back to summary

public Object getData()

A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request.

Since 3.16.0

getMessage	back to summary
public String getMessage() The diagnostic's message. Annotations @NonNull

getMessage

back to summary

public String getMessage()

The diagnostic's message.

Annotations

@NonNull

getRange	back to summary
public Range getRange() The range at which the message applies Annotations @NonNull

getRange

back to summary

public Range getRange()

The range at which the message applies

Annotations

@NonNull

getRelatedInformation	back to summary
public List<DiagnosticRelatedInformation> getRelatedInformation() An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property. Since 3.7.0

getRelatedInformation

back to summary

public List<DiagnosticRelatedInformation> getRelatedInformation()

An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

Since 3.7.0

getSeverity	back to summary
public DiagnosticSeverity getSeverity() The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

getSource	back to summary
public String getSource() A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

getTags	back to summary
public List<DiagnosticTag> getTags() Additional metadata about the diagnostic. Since 3.15.0

getTags

back to summary

public List<DiagnosticTag> getTags()

Additional metadata about the diagnostic.

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

setCode	back to summary
public void setCode(final Either<String, Integer> code) The diagnostic's code. Can be omitted.

setCode	back to summary
public void setCode(final String code)

setCode	back to summary
public void setCode(final Integer code)

setCodeDescription	back to summary
public void setCodeDescription(final DiagnosticCodeDescription codeDescription) An optional property to describe the error code. Since 3.16.0

setCodeDescription

back to summary

public void setCodeDescription(final DiagnosticCodeDescription codeDescription)

An optional property to describe the error code.

Since 3.16.0

setData	back to summary
public void setData(final Object data) A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request. Since 3.16.0

setData

back to summary

public void setData(final Object data)

A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request.

Since 3.16.0

setMessage	back to summary
public void setMessage(final String message) The diagnostic's message.

setRange	back to summary
public void setRange(final Range range) The range at which the message applies

setRelatedInformation	back to summary
public void setRelatedInformation(final List<DiagnosticRelatedInformation> relatedInformation) An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property. Since 3.7.0

setRelatedInformation

back to summary

public void setRelatedInformation(final List<DiagnosticRelatedInformation> relatedInformation)

An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

Since 3.7.0

setSeverity	back to summary
public void setSeverity(final DiagnosticSeverity severity) The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

setSource	back to summary
public void setSource(final String source) A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

setTags	back to summary
public void setTags(final List<DiagnosticTag> tags) Additional metadata about the diagnostic. Since 3.15.0

setTags

back to summary

public void setTags(final List<DiagnosticTag> tags)

Additional metadata about the diagnostic.

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 Diagnostic

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail