Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class NotebookCell

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
com.google.gson.annotations.JsonAdapter, org.eclipse.lsp4j.jsonrpc.json.adapters.JsonElementTypeAdapter, org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

A notebook cell.

A cell's document URI must be unique across ALL notebook cells and can therefore be used to uniquely identify a notebook cell or the cell's text document.

Since 3.17.0

Field Summary

Modifier and TypeField and Description
private String
document

The URI of the cell's text document content.

private ExecutionSummary
executionSummary

Additional execution summary information if supported by the client.

private NotebookCellKind
kind

The cell's kind

private Object
metadata

Additional metadata stored with the cell.

Constructor Summary

AccessConstructor and Description
public
public
NotebookCell(final NotebookCellKind kind, final String document)

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 String
getDocument()

The URI of the cell's text document content.

public ExecutionSummary
getExecutionSummary()

Additional execution summary information if supported by the client.

public NotebookCellKind
getKind()

The cell's kind

public Object
getMetadata()

Additional metadata stored with the cell.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setDocument(final String document)

The URI of the cell's text document content.

public void
setExecutionSummary(final ExecutionSummary executionSummary)

Additional execution summary information if supported by the client.

public void
setKind(final NotebookCellKind kind)

The cell's kind

public void
setMetadata(final Object metadata)

Additional metadata stored with the cell.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

documentback to summary
private String document

The URI of the cell's text document content.

Annotations
@NonNull
executionSummaryback to summary
private ExecutionSummary executionSummary

Additional execution summary information if supported by the client.

kindback to summary
private NotebookCellKind kind

The cell's kind

Annotations
@NonNull
metadataback to summary
private Object metadata

Additional metadata stored with the cell.

Annotations
@JsonAdapter:Factory

Constructor Detail

NotebookCellback to summary
public NotebookCell()
NotebookCellback to summary
public NotebookCell(final NotebookCellKind kind, final String document)

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
getDocumentback to summary
public String getDocument()

The URI of the cell's text document content.

Annotations
@NonNull
getExecutionSummaryback to summary
public ExecutionSummary getExecutionSummary()

Additional execution summary information if supported by the client.

getKindback to summary
public NotebookCellKind getKind()

The cell's kind

Annotations
@NonNull
getMetadataback to summary
public Object getMetadata()

Additional metadata stored with the cell.

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
setDocumentback to summary
public void setDocument(final String document)

The URI of the cell's text document content.

setExecutionSummaryback to summary
public void setExecutionSummary(final ExecutionSummary executionSummary)

Additional execution summary information if supported by the client.

setKindback to summary
public void setKind(final NotebookCellKind kind)

The cell's kind

setMetadataback to summary
public void setMetadata(final Object metadata)

Additional metadata stored with the cell.

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