Package ganymede.shell

Class Builtin

java.lang.Object

ganymede.notebook.AbstractMagic

ganymede.shell.Builtin

All Implemented Interfaces:

AnnotatedMagic, Magic

Direct Known Subclasses:

Classpath, POM

public abstract class Builtin
extends AbstractMagic

Abstract base class for built-in Magics (executed locally in the Shell).

Author:

Allen D. Ball

Nested Class Summary

Nested classes/interfaces inherited from interface ganymede.notebook.Magic

Magic.Application, Magic.completeness

Field Summary

Fields inherited from class ganymede.notebook.AbstractMagic

context, HELPER

Fields inherited from interface ganymede.notebook.Magic

BANG, CELL

Constructor Summary

Constructors

Constructor	Description
Builtin()

Method Summary

Modifier and Type	Method	Description
abstract void	execute(Shell shell, InputStream in, PrintStream out, PrintStream err, Magic.Application application)	Shell execution method.
void	execute(String line0, String code, JsonNode metadata)	JShell execution method.

Methods inherited from class ganymede.notebook.AbstractMagic

configure, getUsage, isComplete, parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ganymede.notebook.AnnotatedMagic

getDescription, getMagicNames, getUsage

Methods inherited from interface ganymede.notebook.Magic

instance

Constructor Detail

Builtin

public Builtin()

Method Detail

execute

public abstract void execute(Shell shell,
                             InputStream in,
                             PrintStream out,
                             PrintStream err,
                             Magic.Application application)
                      throws Exception

Shell execution method.

Parameters:

shell - The Shell.

in - The in InputStream.

out - The out PrintStream.

err - The err PrintStream.

application - The Magic.Application instance.

Throws:

Exception

execute

public void execute(String line0,
                    String code,
                    JsonNode metadata)
             throws Exception

Description copied from interface: Magic

JShell execution method.

Parameters:

line0 - The initial magic line.

code - The remainder of the cell.

metadata - The metadata from the Jupyter execute_request.

Throws:

Exception