[doc] misc. fix & improvements
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jinvoke.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5 * Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
6 *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15 *
16 *
17 -->
18 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="jinvoke">
19     <refnamediv>
20         <refname>jinvoke</refname>
21         <refpurpose>Invoke a method of a Java object</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>
26             ret = jinvoke(object, methodName [, arg_1 [, arg_2...]])
27         </synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Parameters</title>
31         <variablelist>
32             <varlistentry>
33                 <term>object</term>
34                 <listitem>
35                     <para>A mlist typed _JObj or _JClass or a Scilab variable</para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>methodName</term>
40                 <listitem>
41                     <para>A string giving the method name</para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>arg_i</term>
46                 <listitem>
47                     <para>A Scilab variable as method argument</para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection>
53         <title>Description</title>
54         <para>
55             Invoke the Java method (static or not) called methodName of the given object. The result is returned as a mlist typed _JObj.
56         </para>
57         <para>
58             The polymorphism is handled in using Java Reflection and the autoboxing is handled too so ArrayList.add(1.234) or ArrayList.add("Hello") are allowed. If it exists a method Foo.bar(int), it is possible to write Foo.bar(123) even if 123 is a Scilab double but Foo.bar(double), if it exists, will be chosen.
59         </para>
60     </refsection>
61     <refsection>
62         <title>Examples</title>
63         <programlisting role="example"><![CDATA[
64                jimport java.lang.System;
65                jimport java.awt.Color;
66                jimport java.lang.String;
67
68                // Non-static methods
69                jinvoke("Hello World !!", "length");
70                str = String.new("Hello");
71                jinvoke(str,"substring",1, 4)
72
73
74                // Static method
75                T = jinvoke(System, "getProperty", "java.version");
76
77                // Combine
78                c = jinvoke(Color, "decode", "123456");
79                cb = jinvoke(c, "brighter");
80
81                jcode = jinvoke(cb, "getRGB");
82
83                jremove System Color T c cb jcode;
84       ]]></programlisting>
85     </refsection>
86     <refsection role="see also">
87         <title>See also</title>
88         <simplelist type="inline">
89             <member>
90                 <link linkend="jautoUnwrap">jautoUnwrap</link>
91             </member>
92             <member>
93                 <link linkend="jinvoke_db">jinvoke_db</link>
94             </member>
95         </simplelist>
96     </refsection>
97     <refsection>
98         <title>History</title>
99         <revhistory>
100             <revision>
101                 <revnumber>5.5.0</revnumber>
102                 <revremark>
103                     Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
104                 </revremark>
105             </revision>
106         </revhistory>
107     </refsection>
108 </refentry>
109