java.lang.Object
- ganymede.notebook.NotebookContext

```
public class NotebookContext
extends Object
```
NotebookContext for Notebook JShell instance (bound to "$$").

Author:

Allen D. Ball

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class NotebookContext.SQL
SQL-specific context.

Field Summary

Fields
Modifier and Type	Field	Description
`List<String>`	`classpath`	`List` of `classpath` entries.
`ScriptContext`	`context`	Common `ScriptContext` supplied to `Magic.execute(String,String,JsonNode)`.
`List<String>`	`imports`	`List` of accumulated `import`s.
`Kernel`	`kernel`	`Kernel` model.
`static String`	`NAME`	The name ("$$") the `NotebookContext` instance is bound to in the `JShell` instance.
`Session`	`session`	`Session` model.
`NotebookContext.SQL`	`sql`	`SQL`-specific context.
`Map<String,String>`	`types`	`Map` of known bindings' `types`.

Constructor Summary

Constructors
Constructor Description

NotebookContext()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JsonNode`	`asJson(Object object)`	`NotebookFunction` to convert an `Object` to `JSON` representation.
`String`	`asYaml(Object object)`	`NotebookFunction` to convert an `Object` to YAML representation.
`static String`	`bootstrap()`	Method to generate the bootstrap code for a new `JShell` instance.
`void`	`display(Object object)`	`NotebookFunction` to display from a Notebook cell.
`ClassLoader`	`getClassLoader()`	Method to get the `context` `ClassLoader`.
`static Method[]`	`getNotebookFunctions()`	Method to get the `NotebookContext` `Method`s annotated with `NotebookFunction` that should be linked into the `Notebook` environment.
`static Set<String>`	`imports(JShell jshell)`	Static method to get the current imports.
`void`	`invoke(String name)`	Method to receive a `Magic` request in the `JShell` instance.
`static void`	`invoke(JShell jshell, String name)`	Static method to invoke a `Magic` in a `JShell` instance.
`MagicMap`	`magics()`	Provide access to the `NotebookContext` `MagicMap`.
`static void`	`postExecute(JShell jshell)`	Static method used by the `Shell` REPL to update the `NotebookContext` after execution.
`static void`	`preExecute(JShell jshell)`	Static method used by the `Shell` REPL to update the `NotebookContext` instance before execution.
`void`	`print(Object object)`	`NotebookFunction` to print from a Notebook cell.
`void`	`refresh()`	Method to update notebook context.
`static String`	`unescape(String literal)`	Method to unescape a Java-escaped string literal.
`static Map<String,String>`	`variables(JShell jshell)`	Static method to get the current `Map` of defined variables to their type definitions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    The name ("$$") the NotebookContext instance is bound to in the JShell instance.
    
    See Also:
    
    Constant Field Values
  - kernel
```
public Kernel kernel
```
    Kernel model.
  - session
```
public Session session
```
    Session model.
  - context
```
public final ScriptContext context
```
    Common ScriptContext supplied to Magic.execute(String,String,JsonNode).
  - classpath
```
public final List<String> classpath
```
    List of classpath entries.
  - imports
```
public final List<String> imports
```
    List of accumulated imports.
  - types
```
public final Map<String,String> types
```
    Map of known bindings' types.
  - sql
```
public final NotebookContext.SQL sql
```
    SQL-specific context. See SQL.
- Constructor Detail
  - NotebookContext
```
public NotebookContext()
```
- Method Detail
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Method to get the context ClassLoader.
    
    Returns:
    
    The NotebookContext ClassLoader.
  - refresh
```
public void refresh()
```
    Method to update notebook context.
    
    See Also:
    
    kernel
  - magics
```
public MagicMap magics()
```
    Provide access to the NotebookContext MagicMap.
    
    Returns:
    
    The MagicMap.
  - invoke
```
public void invoke(String name)
```
    Method to receive a Magic request in the JShell instance. See invoke(JShell,String).
    
    Parameters:
    
    name - The magic name.
  - display
```
@NotebookFunction
public void display(Object object)
```
    NotebookFunction to display from a Notebook cell.
    
    Parameters:
    
    object - The Object to display.
  - print
```
@NotebookFunction
public void print(Object object)
```
    NotebookFunction to print from a Notebook cell.
    
    Parameters:
    
    object - The Object to print.
  - asJson
```
@NotebookFunction
public JsonNode asJson(Object object)
```
    NotebookFunction to convert an Object to JSON representation.
    
    Parameters:
    
    object - The Object to convert.
    
    Returns:
    
    The JsonNode representation.
  - asYaml
```
@NotebookFunction
public String asYaml(Object object)
```
    NotebookFunction to convert an Object to YAML representation.
    
    Parameters:
    
    object - The Object to convert.
    
    Returns:
    
    The YAML (as a String) representation.
  - bootstrap
```
public static String bootstrap()
```
    Method to generate the bootstrap code for a new JShell instance.
    
    Returns:
    
    The boostrap code.
  - getNotebookFunctions
```
public static Method[] getNotebookFunctions()
```
    Method to get the NotebookContext Methods annotated with NotebookFunction that should be linked into the Notebook environment.
    
    Returns:
    
    The array of Methods.
  - imports
```
public static Set<String> imports(JShell jshell)
```
    Static method to get the current imports.
    
    Parameters:
    
    jshell - The JShell.
    
    Returns:
    
    The Set of imports as Strings.
  - variables
```
public static Map<String,String> variables(JShell jshell)
```
    Static method to get the current Map of defined variables to their type definitions.
    
    Parameters:
    
    jshell - The JShell.
    
    Returns:
    
    The Map of defined variables and their types as Strings.
  - preExecute
```
public static void preExecute(JShell jshell)
```
    Static method used by the Shell REPL to update the NotebookContext instance before execution.
    
    Parameters:
    
    jshell - The JShell.
  - postExecute
```
public static void postExecute(JShell jshell)
```
    Static method used by the Shell REPL to update the NotebookContext after execution.
    
    Parameters:
    
    jshell - The JShell.
  - invoke
```
public static void invoke(JShell jshell,
                          String name)
```
    Static method to invoke a Magic in a JShell instance. See invoke(String).
    
    Parameters:
    
    jshell - The JShell.
    
    name - The magic name.
  - unescape
```
public static String unescape(String literal)
```
    Method to unescape a Java-escaped string literal.
    
    Parameters:
    
    literal - The String to unescape.
    
    Returns:
    
    The unescaped String.

Class NotebookContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

kernel

session

context

classpath

imports

types

sql

Constructor Detail

NotebookContext

Method Detail

getClassLoader

refresh

magics

invoke

display

print

asJson

asYaml

bootstrap

getNotebookFunctions

imports

variables

preExecute

postExecute

invoke

unescape