Record Class MarkdownCell

java.lang.Object

java.lang.Record

smile.util.ipynb.MarkdownCell

Record Components:

id - the unique cell identifier (nbformat ≥ 4.5, required in nbformat 5).

metadata - the cell-level metadata.

source - the Markdown source of the cell.

attachments - optional map of filename to MIME bundle for inline attachments.

All Implemented Interfaces:

Cell

public record MarkdownCell(String id, CellMetadata metadata, MultilineString source, Map<String, Map<String, tools.jackson.databind.JsonNode>> attachments)
extends Record
implements Cell

A markdown cell. Markdown cells contain formatted text written in the Markdown lightweight markup language and have no outputs.

Since nbformat 4.5 / nbformat 5, markdown cells may also carry attachments: inline files (e.g. dragged-in images) stored as a map of filename → MIME bundle.

Constructor Summary

Constructors

Constructor	Description
MarkdownCell(String id, CellMetadata metadata, MultilineString source, Map<String, Map<String, tools.jackson.databind.JsonNode>> attachments)	Creates an instance of a MarkdownCell record class.

Method Summary

Modifier and Type	Method	Description
Map<String, Map<String, tools.jackson.databind.JsonNode>>	attachments()	Returns the value of the attachments record component.
String	cellType()	Returns the cell type identifier.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
CellMetadata	metadata()	Returns the value of the metadata record component.
MultilineString	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MarkdownCell

public MarkdownCell(String id,
 CellMetadata metadata,
 MultilineString source,
 Map<String, Map<String, tools.jackson.databind.JsonNode>> attachments)

Creates an instance of a MarkdownCell 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

attachments - the value for the attachments 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

attachments

public Map<String, Map<String, tools.jackson.databind.JsonNode>> attachments()

Returns the value of the attachments record component.

Returns:

the value of the attachments record component