Changes between Version 15 and Version 16 of JavaFfi

Timestamp:

07/25/14 21:00:43 (7 years ago)

Author:

Robert Goldman

Comment:

Added docs for JCOERCE.

JavaFfi

@@ -219 +219 @@
 
 `(jconstructor "java.util.LinkedList" "java.util.Collection") => #<java.lang.reflect.Constructor public java.util.LinkedList(java... {35EE49}>`
+
+=== Function JCOERCE === 
+
+''Syntax:'''
+
+'''jcoerce''' ''value intended-class''
+
+'''Arguments and Values:'''
+
+`value` -- an arbitrary Common Lisp data item
+
+`intended-class` -- string naming a kind of `java-object`
+
+'''Description:'''
+
+Returns `java-object` of the appropriate type, if it can.  Otherwise raises a `TYPE-ERROR`.  A primary purpose of this function is to translate lisp data items into Java primitives so that Java methods with primitive type arguments can be used.
+
+'''Examples:'''
+
+`(jcoerce 1.0d0 "double") => #<java.lang.Double 1.0 {13424219}>`
+
+` (multiple-value-list (ignore-errors (jcoerce 1.0d0 "int"))) => (NIL #<TYPE-ERROR {236312F7}>)`