396031bf6b3b753e31391d6409e3edd00211cc03
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jallowClassReloading.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * JIMS ( http://forge.scilab.org/index.php/p/JIMS/ ) - This file is a part of JIMS
5 * Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
6 *
7 * This file must be used under the terms of the CeCILL.
8 * This source file is licensed as described in the file COPYING, which
9 * you should have received as part of this distribution.  The terms
10 * are also available at
11 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12 *
13 *
14 -->
15 <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="jallowClassReloading">
16     <refnamediv>
17         <refname>jallowClassReloading</refname>
18         <refpurpose>Allow the class reloading</refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>
23             jallowClassReloading(bool)
24             isAllowed = jallowClassReloading()
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Parameters</title>
29         <variablelist>
30             <varlistentry>
31                 <term>bool</term>
32                 <listitem>
33                     <para>A boolean to allow or disallow</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>isAllowed</term>
38                 <listitem>
39                     <para>A boolean to indicate if the class relaoding is allowed or not</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>
47             Allow or disallow the class reloading. The reloading is only available for the classes which are not distributed in the Java framework. The <literal>jimport</literal> function uses this parameter.
48         </para>
49         <para>
50             By default, it is set to false (since it is a development tool).
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[
56                jallowClassReloading(%t);
57                jallowClassReloading()
58       ]]></programlisting>
59     </refsection>
60     <refsection role="see also">
61         <title>See Also</title>
62         <simplelist type="inline">
63             <member>
64                 <link linkend="jimport">jimport</link>
65             </member>
66         </simplelist>
67     </refsection>
68 </refentry>