Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.NotebookDocument

Modifier and Type	Field and Description
private List<NotebookCell>	cells The cells of a notebook.
private Object	metadata Additional metadata stored with the notebook document.
private String	notebookType The type of the notebook.
private String	uri The notebook document's URI.
private int	version The version number of this document (it will increase after each change, including undo/redo).

Access	Constructor and Description
public	NotebookDocument()
public	NotebookDocument(final String uri, final String notebookType, final int version, final List<NotebookCell> cells)

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 List<NotebookCell>	getCells() The cells of a notebook.
public Object	getMetadata() Additional metadata stored with the notebook document.
public String	getNotebookType() The type of the notebook.
public String	getUri() The notebook document's URI.
public int	getVersion() The version number of this document (it will increase after each change, including undo/redo).
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCells(final List<NotebookCell> cells) The cells of a notebook.
public void	setMetadata(final Object metadata) Additional metadata stored with the notebook document.
public void	setNotebookType(final String notebookType) The type of the notebook.
public void	setUri(final String uri) The notebook document's URI.
public void	setVersion(final int version) The version number of this document (it will increase after each change, including undo/redo).
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

cells	back to summary
private List<NotebookCell> cells The cells of a notebook. Annotations @NonNull

notebookType	back to summary
private String notebookType The type of the notebook. Annotations @NonNull

uri	back to summary
private String uri The notebook document's URI. Annotations @NonNull

version	back to summary
private int version The version number of this document (it will increase after each change, including undo/redo).

NotebookDocument	back to summary
public NotebookDocument()

NotebookDocument	back to summary
public NotebookDocument(final String uri, final String notebookType, final int version, final List<NotebookCell> cells)

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

getCells	back to summary
public List<NotebookCell> getCells() The cells of a notebook. Annotations @NonNull

getCells

back to summary

public List<NotebookCell> getCells()

The cells of a notebook.

Annotations

@NonNull

getMetadata	back to summary
public Object getMetadata() Additional metadata stored with the notebook document.

getNotebookType	back to summary
public String getNotebookType() The type of the notebook. Annotations @NonNull

getNotebookType

back to summary

public String getNotebookType()

The type of the notebook.

Annotations

@NonNull

getUri	back to summary
public String getUri() The notebook document's URI. Annotations @NonNull

getUri

back to summary

public String getUri()

The notebook document's URI.

Annotations

@NonNull

getVersion	back to summary
public int getVersion() The version number of this document (it will increase after each change, including undo/redo).

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

setCells	back to summary
public void setCells(final List<NotebookCell> cells) The cells of a notebook.

setMetadata	back to summary
public void setMetadata(final Object metadata) Additional metadata stored with the notebook document.

setNotebookType	back to summary
public void setNotebookType(final String notebookType) The type of the notebook.

setUri	back to summary
public void setUri(final String uri) The notebook document's URI.

setVersion	back to summary
public void setVersion(final int version) The version number of this document (it will increase after each change, including undo/redo).

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 NotebookDocument

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail