Manipulating the Java Classpath and Imports

The magic %classpath adds jars to the kernel. And the magics %import and %unimport control which classes are visible by default in your code (the regular import command is local to the cell where it runs.

These magics work in all the BeakerX JVM kernels.

Example

This first cell shows that you get an error if you try to import a class not built-in to BeakerX:

In [ ]:
import com.example.Demo

Then load a jar into the kernel:

In [ ]:
%classpath add jar ../resources/jar/demo.jar

After that, it imports and runs:

In [ ]:
import com.example.Demo
Demo demo = new Demo();
println demo.getObjectTest()

You can add multiple jars. Wildcards also work, like they normally do in the classpath (in this case the code could say ../resources/jar/*).

In [ ]:
%classpath add jar ../resources/jar/demo.jar
%classpath add jar ../resources/jar/BeakerXClasspathTest.jar

println com.example.Demo.staticTest();

import com.example.Demo

Demo demo = new Demo();
println demo.getObjectTest()

import com.beaker.BeakerXClasspathTest
BeakerXClasspathTest t = new BeakerXClasspathTest();
println com.beaker.BeakerXClasspathTest.staticTest;
println t.getObjectTest();
OutputCell.HIDDEN

The source code for these jars is in the repository. See Demo.java, and BeakerXClasspathTest.java

With no arguments the classpath magic prints-out all loaded jars:

In [ ]:
%classpath

Loading single Dependency with Grapes and Maven

Groovy has a dependency manager called Grape built-in and you can access it as follows:

In [ ]:
@Grab(group='com.google.code.gson', module='gson', version='2.2.4')
import com.google.gson.GsonBuilder
new GsonBuilder().create().toJson("Hello", System.out)

The %classpath magic also supports loading from maven central:

In [ ]:
%classpath add mvn com.google.code.gson gson 2.2.4
new com.google.gson.GsonBuilder().create().toJson("Hello", System.out)

You can either use gradle like syntax to load dependency

In [ ]:
%classpath add mvn com.sun.jersey:jersey-core:1.19.4
import com.sun.jersey.api.uri.UriBuilderImpl
return new UriBuilderImpl()
            .path("http://beakerx.com/")
            .path("documentation")
            .build();

The %classpath config resolver gives you able to define custom repository

In [ ]:
%classpath config resolver repository.spring.snapshot http://repo.spring.io/snapshot
In [ ]:
%classpath add mvn org.springframework spring-context 5.0.3.BUILD-SNAPSHOT

Loading multiple Dependencies with Maven

You can use %%classpath cell magic to load multiple dependencies at once. Cell magic will create POM file that will contain all dependencies listed in cell.

In [ ]:
%%classpath add mvn
org.slf4j slf4j-api 1.7.25
org.slf4j slf4j-nop 1.7.25

Loading Jars from a Dynamic Location

The above magics work on literal strings. If you need to compute the location of a jar, use the dynamic classpath magic:

In [ ]:
location = "../resources/jar/"
In [ ]:
%classpath add dynamic location + "demo.jar"
In [ ]:
%classpath add dynamic [location + "demo.jar", location + "BeakerXClasspathTest.jar"]

Import and Unimport

Normally import in Groovy only works in the cell where you use it. To make a class import automatically into all cells, use %import magic.

In [ ]:
%import com.twosigma.beakerx.widget.IntSlider
w = new IntSlider()
w.value = 60
w
In [ ]:
w2 = new IntSlider()
In [ ]:
%unimport com.twosigma.beakerx.widget.IntSlider
In [ ]:
w3 = new IntSlider()
In [ ]:
%import static java.lang.Math.PI
In [ ]:
PI

More details of the implementation:

In [ ]:
%classpath add jar ../resources/jar/demo.jar
%classpath
5+5
In [ ]:
%classpath
%classpath add jar ../resources/jar/demo.jar
In [ ]:
%classpath add jar ../resources/jar/demo.jar
%classpath
In [ ]:
%import static com.example.Demo.staticTest
In [ ]:
staticTest()
In [ ]:
%import static com.example.Demo.STATIC_TEST_123
In [ ]:
STATIC_TEST_123
In [ ]:
%import static com.example.Demo.*
In [ ]:
STATIC_TEST_123
In [ ]:
staticTest()