Skip to content

Commit

Permalink
Clarify documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
aviks authored Jul 5, 2016
1 parent 902da00 commit 927d715
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ layout: default

The JavaCall package allows calling Java programs from within Julia code. It uses the Java Native Interface ([JNI][]) to call into an in-process Java Virtual Machine (JVM). The primary entry point to Java is the `jcall` function. This is modeled on the Julia `ccall` function, and takes as input the receiver object (or class, for static methods), the method name, the output type, a tuple of the method parameter types, and the parameters themselves.

This package has been extensively tested using Oracle JDK 7 and Oracle JDK 8 on MacOSX and Ubuntu on 64 bit environments. It has also been shown to work with `OpenJDK` flavoue of java, versions 7 and 8. It _should_ work on Windows. However, it is unlikely to work on a 32 bit environments without further work. It will not work with the Apple 1.6 JDK since that is a 32 bit environment, and Julia is typically built as a 64 bit executable on OSX.
This package has been extensively tested using Oracle JDK 7 and Oracle JDK 8 on MacOSX and Ubuntu on 64 bit environments. It has also been shown to work with `OpenJDK` flavour of java, versions 7 and 8. It has also been tested on Windows 64 bit environments. However, it is does not work on 32 bit environments. It will not work with the Apple 1.6 JDK since that is a 32 bit JVM, and Julia is typically built as a 64 bit executable on OSX.

This comment has been minimized.

Copy link
@tkelman

tkelman Aug 1, 2016

Contributor

Should this be "it does not work" or "it is not working" ?

This comment has been minimized.

Copy link
@aviks

aviks Aug 2, 2016

Author Collaborator

Is there a nuance here that I'm missing?. What I mean, I suppose, is "it has never worked, and is unlikely to be fixed any time soon, since there seems to be some underlying Julia issue" #35

This comment has been minimized.

Copy link
@tkelman

tkelman Aug 2, 2016

Contributor

"it is does not work" is grammatically incorrect

This comment has been minimized.

Copy link
@aviks

aviks Aug 2, 2016

Author Collaborator

Ah, sorry, I could not see the extra "is". Thanks, will fix.


[JNI]: http://docs.oracle.com/javase/1.5.0/docs/guide/jni/spec/jniTOC.html

Expand All @@ -16,7 +16,7 @@ This package has been extensively tested using Oracle JDK 7 and Oracle JDK 8 on
Pkg.add("JavaCall")
```

This package has a dependency on the `Memoize` package
This package has a dependency on the `WinReg` package which, on Windows, is used to derive the location of the JDK automatically.

##Usage

Expand Down Expand Up @@ -58,9 +58,7 @@ julia> jcall(j_u_arrays, "binarySearch", jint, (Array{jint,1}, jint), [10,20,30,

* Currently, only a low level interface is available, via `jcall`. As a result, this package is best suited for writing libraries that wrap around existing java packages. Writing user code direcly using this interface might be a bit tedious at present. A high level interface using reflection will eventually be built.

* Field access is not yet supported. It is unclear if a `Javabeans` style access (i.e. conflating field and getter/setter) is useful.

* While basic memory management has been implemented, there is likely to be some remaining memory leaks in this system. While this should be stable enough for scripting style tasks, more testing is neede before deplying this to long running tasks
* While basic memory management has been implemented, there is the possibility of some remaining memory leaks in this system. While this is stable enough for scripting style tasks, please test yourself before deplying this to long running tasks



0 comments on commit 927d715

Please sign in to comment.