1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
\name{jcall}
\alias{.jcall}
\title{
Call a Java method
}
\description{
\code{.jcall} calls a Java method with the supplied arguments.
}
\usage{
.jcall(obj, returnSig = "V", method, ..., evalArray = TRUE,
evalString = TRUE, check = TRUE, interface = "RcallMethod",
simplify = FALSE, use.true.class = FALSE)
}
\arguments{
\item{obj}{Java object (\code{jobjRef} as returned by
\code{\link{.jcall}} or \code{\link{.jnew}}) or fully qualified
class name in JNI notation (e.g. \code{"java/lang/String"}).}
\item{returnSig}{Return signature in JNI notation (e.g. "V" for void,
"[I" for \code{int[]} etc.). For convenience additional type
\code{"S"} is supported and expanded to
\code{"Ljava/lang/String;"}, re-mapping \code{"T"} to represent the
type \code{short}.}
\item{method}{The name of the method to be called}
\item{...}{
Any parameters that will be passed to the Java method. The parameter
types are determined automatically and/or taken from the
\code{jobjRef} object. All named parameters are discarded.}
\item{evalArray}{This flag determines whether the array return value
is evaluated (\code{TRUE}) or passed back as Java object reference
(\code{FALSE}).}
\item{simplify}{If \code{evalArray} is \code{TRUE} then this argument
is passed to \code{\link{.jevalArray}()}.}
\item{evalString}{This flag determines whether string result is returned
as characters or as Java object reference.}
\item{check}{If set to \code{TRUE} then checks for exceptions are
performed before and after the call using
\code{\link{.jcheck}(silent=FALSE)}. This is usually the desired
behavior, because all calls fail until an exception is cleared.}
\item{interface}{This option is experimental and specifies the
interface used for calling the Java method; the current
implementation supports two interfaces:
\describe{
\item{\code{"RcallMethod"}}{the default interface.}
\item{\code{"RcallSyncMethod"}}{synchronized call of a
method. This has similar effect as using \code{synchronize} in
Java.}
}
}
\item{use.true.class}{logical. If set to \code{TRUE}, the true class
of the returned object will be used instead of the declared signature.
\code{TRUE} allows for example to grab the actual class of an object when
the return type is an interface, or allows to grab an array when the
declared type is Object and the returned object is an array. Use \code{FALSE}
for efficiency when you are sure about the return type. }
}
\value{
Returns the result of the method.
}
\details{
\code{.jcall} requires exact match of argument and return types. For
higher efficiency \code{.jcall} doesn't perform any lookup in the
reflection tables. This means that passing subclasses of the classes
present in the method definition requires explicit casting using
\code{\link{.jcast}}. Passing \code{null} arguments also needs a
proper class specification with \code{\link{.jnull}}.
Java types \code{long} and \code{float} have no corresponding types in
R and therefore any such parameters must be flagged as such using
\code{\link{.jfloat}} and \code{\link{.jlong}} functions respectively.
Java also distinguishes scalar and array types whereas R doesn't have
the concept of a scalar. In R a scalar is basically a vector (called
array in Java-speak) of the length 1. Therefore passing vectors of the
length 1 is ambiguous. \code{.jcall} assumes that any vector of the
length 1 that corresponds to a native Java type is a scalar. All other
vectors are passed as arrays. Therefore it is important to use
\code{\link{.jarray}} if an arbitrary vector (including those of the
length 1) is to be passed as an array parameter.
\emph{Important note about encoding of character vectors:}
Java interface always works with strings in UTF-8 encoding, therefore
the safest way is to run R in a UTF-8 locale. If that is not
possible for some reason, rJava can be used in non-UTF-8 locales,
but care must be taken. Since R 2.7.0 it is possible to associate
encoding with strings and rJava will flag all strings it produces
with the appropriate UTF-8 tag. R will then perform corresponding
appropriate conversions where possible (at a cost of speed and
memory usage), but 3rd party code may not (e.g. older
packages). Also rJava relies on correct encoding flags for strings
passed to it and will attempt to perform conversions where
necessary. If some 3rd party code produces strings incorrectly
flagged, all bets are off.
Finally, for performance reasons class, method and field names as
well as signatures are not always converted and should not contain
non-ASCII characters.
}
\seealso{
\code{\link{.jnew}}, \code{\link{.jcast}}, \code{\link{.jnull}},
\code{\link{.jarray}}
}
\examples{
\dontshow{.jinit()}
.jcall("java/lang/System","S","getProperty","os.name")
if (!nzchar(Sys.getenv("NOAWT"))) {
f <- .jnew("java/awt/Frame","Hello")
.jcall(f,,"setVisible",TRUE)
}
}
\keyword{interface}
|
