Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class VersionedTextDocumentIdentifier

extends TextDocumentIdentifier
Class Inheritance
Annotations
@JsonAdapter:Factory
@SuppressWarnings:all
Imports
com.google.gson.annotations.JsonAdapter, org.eclipse.lsp4j.adapters.VersionedTextDocumentIdentifierTypeAdapter, org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

An identifier to denote a specific version of a text document. This information usually flows from the client to the server.

Field Summary

Modifier and TypeField and Description
private Integer
version

The version number of this document.

Constructor Summary

AccessConstructor and Description
public
public
public
VersionedTextDocumentIdentifier(final Integer version)
Deprecated

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides org.eclipse.lsp4j.TextDocumentIdentifier.equals.

Indicates whether some other object is "equal to" this one.

public Integer
getVersion()

The version number of this document.

public int
hashCode()

Overrides org.eclipse.lsp4j.TextDocumentIdentifier.hashCode.

Returns a hash code value for this object.

public void
setVersion(final Integer version)

The version number of this document.

public String
toString()

Overrides org.eclipse.lsp4j.TextDocumentIdentifier.toString.

Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.TextDocumentIdentifier:
getUrisetUri

Field Detail

versionback to summary
private Integer version

The version number of this document. If a versioned text document identifier is sent from the server to the client and the file is not open in the editor (the server has not received an open notification before) the server can send `null` to indicate that the version is known and the content on disk is the truth (as specified with document content ownership).

Constructor Detail

VersionedTextDocumentIdentifierback to summary
public VersionedTextDocumentIdentifier()
VersionedTextDocumentIdentifierback to summary
public VersionedTextDocumentIdentifier(final String uri, final Integer version)
VersionedTextDocumentIdentifierback to summary
public VersionedTextDocumentIdentifier(final Integer version)

Deprecated

Annotations
@Deprecated

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.TextDocumentIdentifier.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
getVersionback to summary
public Integer getVersion()

The version number of this document. If a versioned text document identifier is sent from the server to the client and the file is not open in the editor (the server has not received an open notification before) the server can send `null` to indicate that the version is known and the content on disk is the truth (as specified with document content ownership).

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.TextDocumentIdentifier.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
setVersionback to summary
public void setVersion(final Integer version)

The version number of this document. If a versioned text document identifier is sent from the server to the client and the file is not open in the editor (the server has not received an open notification before) the server can send `null` to indicate that the version is known and the content on disk is the truth (as specified with document content ownership).

toStringback to summary
public String toString()

Overrides org.eclipse.lsp4j.TextDocumentIdentifier.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