Top Fields Constructors Methods
org.eclipse.lsp4j

public Class TextDocumentSyncOptions

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.messages.Either, org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder

Field Summary

Modifier and TypeField and Description
private TextDocumentSyncKind
change

Change notifications are sent to the server.

private Boolean
openClose

Open and close notifications are sent to the server.

private Either<Boolean, SaveOptions>
save

Save notifications are sent to the server.

private Boolean
willSave

Will save notifications are sent to the server.

private Boolean
willSaveWaitUntil

Will save wait until requests are sent to the server.

Constructor Summary

AccessConstructor and Description
public

Method Summary

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

Overrides java.lang.Object.equals.

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

public TextDocumentSyncKind
getChange()

Change notifications are sent to the server.

public Boolean
getOpenClose()

Open and close notifications are sent to the server.

public Either<Boolean, SaveOptions>
getSave()

Save notifications are sent to the server.

public Boolean
getWillSave()

Will save notifications are sent to the server.

public Boolean
getWillSaveWaitUntil()

Will save wait until requests are sent to the server.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setChange(final TextDocumentSyncKind change)

Change notifications are sent to the server.

public void
setOpenClose(final Boolean openClose)

Open and close notifications are sent to the server.

public void
setSave(final Either<Boolean, SaveOptions> save)

Save notifications are sent to the server.

public void
setSave(final Boolean save)

public void
setSave(final SaveOptions save)

public void
setWillSave(final Boolean willSave)

Will save notifications are sent to the server.

public void
setWillSaveWaitUntil(final Boolean willSaveWaitUntil)

Will save wait until requests are sent to the server.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

changeback to summary
private TextDocumentSyncKind change

Change notifications are sent to the server. If omitted it defaults to TextDocumentSyncKind#None.

openCloseback to summary
private Boolean openClose

Open and close notifications are sent to the server. If omitted open close notifications should not be sent.

saveback to summary
private Either<Boolean, SaveOptions> save

Save notifications are sent to the server.

willSaveback to summary
private Boolean willSave

Will save notifications are sent to the server.

willSaveWaitUntilback to summary
private Boolean willSaveWaitUntil

Will save wait until requests are sent to the server.

Constructor Detail

TextDocumentSyncOptionsback to summary
public TextDocumentSyncOptions()

Method Detail

equalsback 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
getChangeback to summary
public TextDocumentSyncKind getChange()

Change notifications are sent to the server. If omitted it defaults to TextDocumentSyncKind#None.

getOpenCloseback to summary
public Boolean getOpenClose()

Open and close notifications are sent to the server. If omitted open close notifications should not be sent.

getSaveback to summary
public Either<Boolean, SaveOptions> getSave()

Save notifications are sent to the server.

getWillSaveback to summary
public Boolean getWillSave()

Will save notifications are sent to the server.

getWillSaveWaitUntilback to summary
public Boolean getWillSaveWaitUntil()

Will save wait until requests are sent to the server.

hashCodeback 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
setChangeback to summary
public void setChange(final TextDocumentSyncKind change)

Change notifications are sent to the server. If omitted it defaults to TextDocumentSyncKind#None.

setOpenCloseback to summary
public void setOpenClose(final Boolean openClose)

Open and close notifications are sent to the server. If omitted open close notifications should not be sent.

setSaveback to summary
public void setSave(final Either<Boolean, SaveOptions> save)

Save notifications are sent to the server.

setSaveback to summary
public void setSave(final Boolean save)
setSaveback to summary
public void setSave(final SaveOptions save)
setWillSaveback to summary
public void setWillSave(final Boolean willSave)

Will save notifications are sent to the server.

setWillSaveWaitUntilback to summary
public void setWillSaveWaitUntil(final Boolean willSaveWaitUntil)

Will save wait until requests are sent to the server.

toStringback 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