Record Class CodeCell

java.lang.Object
java.lang.Record
smile.util.ipynb.CodeCell
Record Components:
id - the unique cell identifier (required in nbformat 5).
metadata - the cell-level metadata.
source - the source code of the cell.
outputs - the list of outputs produced by executing the cell.
executionCount - the prompt number; null if the cell has never been executed.
All Implemented Interfaces:
Cell
public record CodeCell(String id, CellMetadata metadata, MultilineString source, List<Output> outputs, Integer executionCount) extends Record implements Cell
A code cell. Code cells contain executable source code in the kernel language and may carry a list of outputs generated during execution.

The id field is required in nbformat 5 (nbformat_minor ≥ 4).

  • Constructor Details

    • CodeCell

      public CodeCell(String id, CellMetadata metadata, MultilineString source, List<Output> outputs, Integer executionCount)
      Creates an instance of a CodeCell record class.
      Parameters:
      id - the value for the id record component
      metadata - the value for the metadata record component
      source - the value for the source record component
      outputs - the value for the outputs record component
      executionCount - the value for the executionCount record component

  • Method Details

    • cellType

      public String cellType()
      Description copied from interface: Cell
      Returns the cell type identifier.
      Specified by:
      cellType in interface Cell
      Returns:
      "code", "markdown", or "raw".

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public String id()
      Returns the value of the id record component.
      Specified by:
      id in interface Cell
      Returns:
      the value of the id record component

    • metadata

      public CellMetadata metadata()
      Returns the value of the metadata record component.
      Specified by:
      metadata in interface Cell
      Returns:
      the value of the metadata record component

    • source

      public MultilineString source()
      Returns the value of the source record component.
      Specified by:
      source in interface Cell
      Returns:
      the value of the source record component

    • outputs

      public List<Output> outputs()
      Returns the value of the outputs record component.
      Returns:
      the value of the outputs record component

    • executionCount

      public Integer executionCount()
      Returns the value of the executionCount record component.
      Returns:
      the value of the executionCount record component