[doc] misc. fix & improvements
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jautoUnwrap.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="jautoUnwrap">
19     <refnamediv>
20         <refname>jautoUnwrap</refname>
21         <refpurpose>Unwrap automatically returned values</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>
26             autoUnwrap = jautoUnwrap()
27             jautoUnwrap(autoUnwrap)
28         </synopsis>
29     </refsynopsisdiv>
30     <refsection>
31         <title>Parameters</title>
32         <variablelist>
33             <varlistentry>
34                 <term>autoUnwrap</term>
35                 <listitem>
36                     <para>A boolean</para>
37                 </listitem>
38             </varlistentry>
39         </variablelist>
40     </refsection>
41     <refsection>
42         <title>Description</title>
43         <para>
44             If autoUnwrap is true, all the values returned by a method invocation are unwrapped if it is possible.
45         </para>
46         <para>
47             This strongly simplifies the usage of the Java / Scilab conversions.
48         </para>
49         <para>
50             By default, autoUnwrap is true.
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[
56                jautoUnwrap(%f);
57                jautoUnwrap()
58                jautoUnwrap(%t);
59       ]]></programlisting>
60         <programlisting role="example"><![CDATA[
61 // In this example, without disabling the auto unwrap, Scilab will try to
62 // convert the result of currentTimeMillis to a long (which is not yet
63 // supported in Scilab)
64 // Without the auto unwrap, Scilab will keep a reference to the object
65
66                jautoUnwrap(%f)
67                jimport java.util.Date;
68                jimport java.lang.System;
69
70                t = System.currentTimeMillis();
71                s = jnewInstance(Date, t);
72                str = jnewInstance("java.lang.String", "Hello");
73                d = s.toString()
74
75                jremove Date System t s str;
76                jautoUnwrap(%t)
77       ]]></programlisting>
78
79     </refsection>
80     <refsection role="see also">
81         <title>See also</title>
82         <simplelist type="inline">
83             <member>
84                 <link linkend="jinvoke">jinvoke</link>
85             </member>
86         </simplelist>
87     </refsection>
88     <refsection>
89         <title>History</title>
90         <revhistory>
91             <revision>
92                 <revnumber>5.5.0</revnumber>
93                 <revremark>
94                     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.
95                 </revremark>
96             </revision>
97         </revhistory>
98     </refsection>
99 </refentry>
100