annotate scripts/deprecated/java_set.m @ 18979:59975c3cea6b gui-release

maint: Periodic merge of stable to gui-release.
author Rik <rik@octave.org>
date Mon, 02 Jun 2014 09:00:22 -0700
parents e124ae274013
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2012-2013 Rik Wehbring
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
18
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Loadable Function} {@var{obj} =} java_set (@var{obj}, @var{name}, @var{val})
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
21 ## Set the value of the field @var{name} of the Java object @var{obj} to
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
22 ## @var{val}. For static fields, @var{obj} can be a string representing the
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
23 ## fully qualified named of the corresponding Java class.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
24 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
25 ## When @var{obj} is a regular Java object, structure-like indexing can be
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
26 ## used as a shortcut syntax. For instance, the two following statements are
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
27 ## equivalent
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
28 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
29 ## @example
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
30 ## @group
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
31 ## java_set (x, "field1", val)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
32 ## x.field1 = val
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
33 ## @end group
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
34 ## @end example
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
35 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
36 ## @seealso{java_get, javaMethod, javaObject}
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
37 ## @end deftypefn
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
38
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
39 function retval = java_set (obj, name, val)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
40
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
41 persistent warned = false;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
42 if (! warned)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
43 warned = true;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
44 warning ("Octave:deprecated-function",
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
45 "java_set is obsolete and will be removed from a future version of Octave; use structure-like indexing instead");
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
46 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
47
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
48 if (nargin != 3)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
49 print_usage ();
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
50 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
51
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
52 if (isjava (obj))
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
53 obj.(name) = val;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
54 elseif (ischar (obj))
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
55 ## FIXME: Need a solution for getting static fields of class
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
56 ## which does not depend on __java_set__ which will be removed.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
57 retval = __java_set__ (obj, name, val);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
58 else
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
59 error ("java_set: OBJ must be a Java object");
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
60 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
61
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
62 endfunction
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
63