Object Mentor Blog: Java calling Clojure.

Java calling Clojure.

Uncle Bob — Fri, 07 Aug 2009 17:00:43 -0500

While I think Clojure is an interesting language, in order for it to be of real practical use, I must be able to use it in conjunction with other systems I am working on. Specifically, I’d like to write some FitNesse tools in Clojure; but for that to work, I’ll need to call into my Clojure code from Java.

Today, my son Justin and I managed to do just that by following the instruction in Stuart Halloway’s book, the Clojure api website, and Mark Volkmann’s very useful site.

Be advised, that it takes a bit of fiddling to get this to work. You will have to jockey around with your classpaths and output directories. But it’s not actually that hard to do, and the results can be very rewarding.

We implemented the Bowling game (again), but this time we wrote the unit tests in Java, and had them call into Clojure. From the point of view of the Java tests, it looked just like we were calling into java code. The tests had no idea that this was Clojure.

Here are the tests:

package bowling;

import static org.junit.Assert.assertEquals;
import org.junit.Before;
import org.junit.Test;

public class BowlingTest {
  private Game g;

  @Before
  public void setup() {
    g = new Game();
  }

  @Test
  public void roll() throws Exception {
    g.roll(0);
  }

  @Test
  public void gutterGame() throws Exception {
    rollMany(20, 0);
    assertEquals(0, g.score());
  }

  private void rollMany(int n, int pins) {
    for (int i=0; i< n; i++) {
      g.roll(pins);
    }
  }

  @Test
  public void allOnes() throws Exception {
    rollMany(20, 1);
    assertEquals(20, g.score());    
  }

  @Test
  public void oneSpare() throws Exception {
    g.roll(5);
    g.roll(5);
    g.roll(3);
    rollMany(17, 0);
    assertEquals(16, g.score());
  }

  @Test
  public void oneStrike() throws Exception {
    g.roll(10);
    g.roll(5);
    rollMany(17,0);
    assertEquals(20, g.score());
  }

  @Test
  public void perfectGame() throws Exception {
    rollMany(12, 10);
    assertEquals(300, g.score());
  }

  @Test
  public void allSpares() throws Exception {
    rollMany(21, 5);
    assertEquals(150, g.score());
  }
}

The clojure code to make them pass looks like this:

(ns bowling.Game
  (:gen-class
    :state state
    :init init
    :methods [
    [roll [int] void]
    [score [] int]
    ]))

(defn -init [] [[] (atom [])])

(defn -roll [this pins]
  (reset! (.state this) (conj @(.state this) pins)))

(declare score-frames)

(defn -score [this]
  (reduce + (take 10 (score-frames [] (conj @(.state this) 0)))))

(defn score-frames [scores [first second third :as rolls]]
  (cond
    (or (empty? rolls) (nil? second) (nil? third)) scores
    (= 10 first) (recur (conj scores (+ 10 second third)) (next rolls))
    (= 10 (+ first second)) (recur (conj scores (+ 10 third)) (nnext rolls))
    :else
    (recur (conj scores (+ first second)) (nnext rolls))))

The magic is all up in that (ns bowling.game… block.

The name of the java class is Game in the bowling package, or just bowling.Game.
Clojure will create a special member function named state that you can use to squirrel away the state variables of the class.
A function named -init will be called when your class is constructed. You must write this function to return a vector containing 1) a vector of all the arguments to pass to the base class constructor (in my case none), and the initial state of the newly created instance, (in my case an empty vector stuffed into an atom)
The class will have two new methods, roll, which takes an int and returns void, and score which takes nothing and returns an int.

When a method is called on the instance, Clojure automatically invokes a function of the same name, but prefixed by a -, so -roll and -score are the implementations of the roll and score methods. Note that each of these functions take a this argument. You can get the state out of this by saying (.state this).

From a source code point of view, that’s about all there is to it. But how do you compile this into a java .class file?

Here’s what we did. We created a new file named compile.clj that looks like this:

(set! *compile-path* "../../classes")
(compile 'bowling.Game)

We can run this file from our IDE (IntelliJ using the LAClojure plugin) and it will compile quite nicely. But there are a few things you have to make sure you do.

Find out where your IDE puts the .class files, and set the compile-path variable to that directory.
Also make sure that directory is in your classpath.
Make sure that directory exists!
Also make sure that your source file directory (the directory that contains the packages) is in your classpath. (I know… but that’s apparently what it takes.)

You will get errors. And the errors aren’t particularly informative. The key to understanding them is to look at the backtrace of the exceptions they throw. Notice, for example, if the function “WriteClassFile” (or something like that) is buried in the backtrace. If so, you are probably having trouble writing your class file.

In the end, we wrote up an ant script that compiled our clojure and our java together. (You have to compile them in the right order! If java calls Clojure, those .class files have to exist before the java will compile!)

The ant script we used was created for us by IntelliJ, and then we modified it to get it to work. I include it here with the caveat that we made it work, but we didn’t make it “right”. You can ignore most of the stuff at the beginning. The interesting part is the Clojure target, and the clean target.

<?xml version="1.0" encoding="UTF-8"?>
<project name="bowlingforjunit" default="all">

  <property file="bowlingforjunit.properties"/>
  <!-- Uncomment the following property if no tests compilation is needed -->
  <!-- 
  <property name="skip.tests" value="true"/>
   -->

  <!-- Compiler options -->

  <property name="compiler.debug" value="on"/>
  <property name="compiler.generate.no.warnings" value="off"/>
  <property name="compiler.args" value=""/>
  <property name="compiler.max.memory" value="128m"/>
  <patternset id="ignored.files">
    <exclude name="**/CVS/**"/>
    <exclude name="**/SCCS/**"/>
    <exclude name="**/RCS/**"/>
    <exclude name="**/rcs/**"/>
    <exclude name="**/.DS_Store/**"/>
    <exclude name="**/.svn/**"/>
    <exclude name="**/.pyc/**"/>
    <exclude name="**/.pyo/**"/>
    <exclude name="**/*.pyc/**"/>
    <exclude name="**/*.pyo/**"/>
    <exclude name="**/.git/**"/>
    <exclude name="**/.sbas/**"/>
    <exclude name="**/.IJI.*/**"/>
    <exclude name="**/vssver.scc/**"/>
    <exclude name="**/vssver2.scc/**"/>
  </patternset>
  <patternset id="library.patterns">
    <include name="*.zip"/>
    <include name="*.war"/>
    <include name="*.egg"/>
    <include name="*.ear"/>
    <include name="*.swc"/>
    <include name="*.jar"/>
  </patternset>
  <patternset id="compiler.resources">
    <include name="**/?*.properties"/>
    <include name="**/?*.xml"/>
    <include name="**/?*.gif"/>
    <include name="**/?*.png"/>
    <include name="**/?*.jpeg"/>
    <include name="**/?*.jpg"/>
    <include name="**/?*.html"/>
    <include name="**/?*.dtd"/>
    <include name="**/?*.tld"/>
    <include name="**/?*.ftl"/>
  </patternset>

  <!-- JDK definitions -->

  <property name="jdk.bin.1.6" value="${jdk.home.1.6}/bin"/>
  <path id="jdk.classpath.1.6">
    <fileset dir="${jdk.home.1.6}">
      <include name="lib/deploy.jar"/>
      <include name="lib/dt.jar"/>
      <include name="lib/javaws.jar"/>
      <include name="lib/jce.jar"/>
      <include name="lib/management-agent.jar"/>
      <include name="lib/plugin.jar"/>
      <include name="lib/sa-jdi.jar"/>
      <include name="../Classes/charsets.jar"/>
      <include name="../Classes/classes.jar"/>
      <include name="../Classes/dt.jar"/>
      <include name="../Classes/jce.jar"/>
      <include name="../Classes/jconsole.jar"/>
      <include name="../Classes/jsse.jar"/>
      <include name="../Classes/laf.jar"/>
      <include name="../Classes/management-agent.jar"/>
      <include name="../Classes/ui.jar"/>
      <include name="lib/ext/apple_provider.jar"/>
      <include name="lib/ext/dnsns.jar"/>
      <include name="lib/ext/localedata.jar"/>
      <include name="lib/ext/sunjce_provider.jar"/>
      <include name="lib/ext/sunpkcs11.jar"/>
    </fileset>
  </path>

  <property name="project.jdk.home" value="${jdk.home.1.6}"/>
  <property name="project.jdk.bin" value="${jdk.bin.1.6}"/>
  <property name="project.jdk.classpath" value="jdk.classpath.1.6"/>

  <!-- Project Libraries -->

  <!-- Global Libraries -->

  <path id="library.clojure.classpath">
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/ant-launcher.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/ant.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/clojure-contrib.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/clojure.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/commons-codec-1.3.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/commons-fileupload-1.2.1.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/commons-io-1.4.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/compojure.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/hsqldb.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/jetty-6.1.14.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/jetty-util-6.1.14.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/jline-0.9.94.jar"/>
    <pathelement location="/Users/unclebob/projects/clojure-build/lib/servlet-api-2.5-6.1.14.jar"/>
  </path>

  <!-- Modules -->

  <!-- Module BowlingForJunit -->

  <dirname property="module.bowlingforjunit.basedir" file="${ant.file}"/>

  <property name="module.jdk.home.bowlingforjunit" value="${project.jdk.home}"/>
  <property name="module.jdk.bin.bowlingforjunit" value="${project.jdk.bin}"/>
  <property name="module.jdk.classpath.bowlingforjunit" value="${project.jdk.classpath}"/>

  <property name="compiler.args.bowlingforjunit" value="${compiler.args}"/>

  <property name="bowlingforjunit.output.dir" value="${module.bowlingforjunit.basedir}/classes"/>
  <property name="bowlingforjunit.testoutput.dir" value="${module.bowlingforjunit.basedir}/classes"/>

  <path id="bowlingforjunit.module.bootclasspath">
    <!-- Paths to be included in compilation bootclasspath -->
  </path>

  <path id="bowlingforjunit.module.classpath">
    <path refid="${module.jdk.classpath.bowlingforjunit}"/>
    <pathelement location="/Library/junit4.6/junit-4.6.jar"/>
    <path refid="library.clojure.classpath"/>
    <pathelement location="${basedir}/classes"/>
  </path>

  <path id="bowlingforjunit.runtime.module.classpath">
    <pathelement location="${bowlingforjunit.output.dir}"/>
    <pathelement location="/Library/junit4.6/junit-4.6.jar"/>
    <path refid="library.clojure.classpath"/>
    <pathelement location="${basedir}/classes"/>
  </path>

  <patternset id="excluded.from.module.bowlingforjunit">
    <patternset refid="ignored.files"/>
  </patternset>

  <patternset id="excluded.from.compilation.bowlingforjunit">
    <patternset refid="excluded.from.module.bowlingforjunit"/>
  </patternset>

  <path id="bowlingforjunit.module.sourcepath">
    <dirset dir="${module.bowlingforjunit.basedir}">
      <include name="src"/>
    </dirset>
  </path>

  <target name="compile" depends="clojure, compile.java" description="Compile module BowlingForJunit"/>

  <target name="compile.java" description="Compile module BowlingForJunit; production classes">
    <mkdir dir="${bowlingforjunit.output.dir}"/>
    <javac destdir="${bowlingforjunit.output.dir}" debug="${compiler.debug}" nowarn="${compiler.generate.no.warnings}" 
           memorymaximumsize="${compiler.max.memory}" fork="true" executable="${module.jdk.bin.bowlingforjunit}/javac">
      <compilerarg line="${compiler.args.bowlingforjunit}"/>
      <bootclasspath refid="bowlingforjunit.module.bootclasspath"/>
      <classpath refid="bowlingforjunit.module.classpath"/>
      <src refid="bowlingforjunit.module.sourcepath"/>
      <patternset refid="excluded.from.compilation.bowlingforjunit"/>
    </javac>

    <copy todir="${bowlingforjunit.output.dir}">
      <fileset dir="${module.bowlingforjunit.basedir}/src">
        <patternset refid="compiler.resources"/>
        <type type="file"/>
      </fileset>
    </copy>
  </target>

  <target name="clojure">
    <java classname="clojure.lang.Compile">
      <classpath>
        <path location="/Users/unclebob/projects/clojure/BowlingForJunit/classes"/>
        <path location="/Users/unclebob/projects/clojure/BowlingForJunit/src"/>        
        <path location="/Users/unclebob/projects/clojure/BowlingForJunit/src/bowling"/>
        <path location="/Users/unclebob/projects/clojure-build/lib/clojure.jar"/>
        <path location="/Users/unclebob/projects/clojure-build/lib/clojure-contrib.jar"/>  
      </classpath>
      <sysproperty key="clojure.compile.path" value="/Users/unclebob/projects/clojure/BowlingForJunit/classes"/>
      <sysproperty key="java.awt.headless" value="true"/>
      <arg value="bowling.Game"/>
    </java>
  </target>

  <target name="clean" description="cleanup module">
    <delete dir="${bowlingforjunit.output.dir}"/>
    <delete dir="${bowlingforjunit.testoutput.dir}"/>
    <mkdir  dir="${bowlingforjunit.output.dir}"/>
  </target>

  <target name="all" depends="clean, compile" description="build all"/>
</project>

"Java calling Clojure." by Discount Louboutin Shoes

Wed, 11 Jan 2012 20:07:18 -0600

Every women always has Christian Louboutins Wedding Shoes turn of fame but it also has its own goodbyes.

"Java calling Clojure." by christian louboutin

Thu, 03 Nov 2011 11:40:02 -0500

Great website you have here but I was curious if you knew of any community forums that cover the same topics talked about in this article? I’d really like to be a part of group where I can get responses from other knowledgeable individuals that share the same interest. If you have any suggestions, please let me know. Kudos!

"Java calling Clojure." by christian louboutin

Thu, 03 Nov 2011 11:13:25 -0500

The professional design make you foot more comfortable. Even more tantalizing,this pattern make your legs look as long as you can,it will make you looked more attractive.Moveover,it has reasonable price.If you are a popular woman,do not miss it.

Technical details of Christian Louboutin Velours Scrunch Suede Boots Coffee:

Color: Coffee
Material: Suede
4(100mm) heel
Signature red sole x

Fashion, delicate, luxurious Christian louboutins shoes on sale, one of its series is Christian Louboutin Tall Boots, is urbanism collocation. This Christian louboutins shoes design makes people new and refreshing. Red soles shoes is personality, your charm will be wonderful performance.

"Java calling Clojure." by ysbearing/yisong@1stbearing.com

Wed, 19 Oct 2011 02:00:20 -0500

Slewing bearing called slewing ring bearings, is a comprehensive load to bear a large bearing, can bear large axial, radial load and overturning moment. http://www.1stbearing.com

"Java calling Clojure." by Tips For Bowling

Tue, 18 Oct 2011 12:11:57 -0500

"Java calling Clojure." by MTS ????????? Mac

Tue, 11 Oct 2011 01:01:58 -0500

The public may not have known what the messages meant, but it helped pay for them. The skywriting stunt was supported by city and state public funding, according to the High Line’s website. MTS ??? “I wanted a narrative trajectory towards something optimistic at the end, which was the last message, ‘Now Open,’” she said of the work. MTS ??? Mac

"Java calling Clojure." by best sleep aid

Fri, 30 Sep 2011 13:21:43 -0500

When I at first left a comment I clicked the “Notify me when new comments are added” checkbox and now each time a comment is added I get three notification emails with the same comment. Is there any way you can take away people from that service? Thanks a lot!

"Java calling Clojure." by Tory Burch outlet store

Wed, 21 Sep 2011 21:17:12 -0500

It was a beneficial workout for me to go through your webpage

"Java calling Clojure." by canada goose coat

Mon, 19 Sep 2011 02:23:10 -0500

Canada Goose Outlet is Marmot 8000M Parka. The Marmot 8000M Parka is really a waterproof, breathable jacket with 800 fill canada goose jacket feathers. It truly is design and light colored shell is produced for trendy, but uncomplicated, protection from cold temperatures. Reinforced shoulders, elbows and adjustable waist and hem make the Marmot a perfect alternate for skiing and other outdoor sports that want fairly a bit of arm motion. The 8000M Parka weighs three lbs., comes in bonfire and black colours and might be stuffed and stored like a sleeping bag to your convenience.This is one of well-know and prime down jacket brands.Hope our friends like its!Like canada goose womens and Canada Goose Expedition Parka.There are wholesale canada goose.

"Java calling Clojure." by beats by dre store

Tue, 23 Aug 2011 03:40:25 -0500

, I really enjoyed reading it and will certainly share this post with my friends . Learn high quality headphones new design headphones

"Java calling Clojure." by Crystal Jewellery

Thu, 18 Aug 2011 13:08:10 -0500

Great post! Nice and informative, I really enjoyed reading it and will certainly share this post with my friends . Learn everything about what is cubic zirconia

"Java calling Clojure." by danner boots

Thu, 09 Jun 2011 04:04:00 -0500

thinking about which i listen to an eclectic danner boots

"Java calling Clojure." by danner boots

Thu, 09 Jun 2011 03:59:56 -0500

The ant script we used was created for us by IntelliJ danner boots

"Java calling Clojure." by beats by dr dre headphones

Thu, 09 Jun 2011 02:56:47 -0500

I attempted these beats by dr dre studio out in several genres thinking about which i listen to an eclectic mix Beats By Dr Dre. a washing cloth as well as the manual. Do not purchase any beats by dr dre solo purple products inside the internet unless you’re getting from an Authorized internet DealerBeats By Dre Just Solo. We are reliable provide good beats by dr dre pro black by reduced price.

"Java calling Clojure." by Hancy

Wed, 08 Jun 2011 10:52:36 -0500

Hello Friend,Whichever style of Fashion Shoes you’re looking for, classical, fashionable, lovely or the latest design, you can find your favorite designer shoes in www.dunkpage.com ,several days ago I bought one pair of shoes from there,It’s beautiful and very comfortable!

"Java calling Clojure." by Jewellery

Mon, 06 Jun 2011 00:35:32 -0500

Online UK costume and fashion jewellery shop with,

"Java calling Clojure." by coach purses

Mon, 23 May 2011 21:59:47 -0500

Mr Coates coach purses is the longest U.S. market popular with one of the most successful leather brand. Mr Coates coach purses store represents the most admirable American fashion innovative style and traditional skills . Mr Coates coach bags have durable quality and exquisite technology, Conspicuous Coach Heels in the female consumers have good reputation. Welcome to our shop Elegant Coach Purses

"Java calling Clojure." by Movies 2011

Mon, 23 May 2011 02:28:26 -0500

Bad news has wings. Better to ask the way than go astray. By reading we enrich the mind, by conversation we

"Java calling Clojure." by Futons Lover

Fri, 20 May 2011 09:12:43 -0500

I got curious and followed the same procedure. I got errors initially. But the errors were not that informative.

"Java calling Clojure." by Futons Lover

Fri, 20 May 2011 09:12:14 -0500

I got curious and followed the same procedure. I got errors initially. But the errors were not that informative.

"Java calling Clojure." by Great post, thanks

Thu, 28 Apr 2011 20:44:26 -0500

Designer handbags are considered prized possessions by most women all over the world. And phillip lim handbags add class and sophistication to one’s style quotient, giving that extra dose required to make heads turn. Most people all over the world love to own at least one designer brand or another, and strive to fill their wardrobe with collection of big names; be it clothes, designer bags or shoes and boots. phillip lim handbags are especially a favorite with women; who simply go crazy if they can get hold of handbags that are used by celebrities and big shots of the Hollywood industry. In many cases, ladies have gone an extra mile to pay steep prices for designer bags, just because of the brand name. But this is not so with phillip lim handbags. It is quite affordable, and the best part is you get value for money. The exceptional designs, durable quality, unique patterns and great stitching and craftsmanship have all made this brand a name to reckon with. http://www.mona.uwi.edu/">phillip lim handbags change their style very often; but with a Phillip Lim you needn’t worry about changing it every other day since the name in itself creates magic.

"Java calling Clojure." by okey oyunu oyna

Thu, 28 Apr 2011 15:11:59 -0500

useful article. Thanks

internette görüntülü olarak okey oyunu oyna, gerçek kisilerle tanis, turnuva heyecanini yasa.

"Java calling Clojure." by belstaff

Thu, 21 Apr 2011 19:32:38 -0500

In order to meet all demands, producing belstaff jackets
never reduce. So many brands in the world conluding North Face jackets, Mens Belstaff Jackets
, columbia jackets and also spyder belstaff jacket
, each of them is high quality, workmanship, stylish and comfortable, add waterproof and durable freature, they also support for extreme sports.

"Java calling Clojure." by coach bags

Tue, 19 Apr 2011 22:26:55 -0500

good post,i like this

"Java calling Clojure." by www.belstafflondon.com

Thu, 14 Apr 2011 21:09:22 -0500

They are fashionable and difficult at travel and out door. belstaff colonial collection goes with well. Our belstaff synthetic belstaff jacket sunglasses withtremendous discounted and free shipping. you could potentially conserve 50%-60% off at our belstaff sale.You must know regarding the manufacturer title men monclerbelstaff jackets in the event that you could potentially be an outdoor enthusiast.