Mercurial > hg > octave-nkf

annotate scripts/deprecated/java_invoke.m @ 20279:db30302bedc3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag rc-4-0-0-3 for changeset 065f933ef083
author John W. Eaton <jwe@octave.org>
date Fri, 10 Apr 2015 14:41:21 -0400
parents 9fc020886ae9
children bcf0a288aa6c
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) 2007, 2013 Michael Goffioul
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 {Built-in Function} {@var{ret} =} java_invoke (@var{obj}, @var{methodname})
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
21 ## @deftypefnx {Built-in Function} {@var{ret} =} java_invoke (@var{obj}, @var{methodname}, @var{arg1}, @dots{})
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
22 ## Invoke the method @var{methodname} on the Java object @var{obj} with the
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
23 ## arguments @var{arg1}, @dots{} For static methods, @var{obj} can be a
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 18102
diff changeset
24 ## string representing the fully qualified name of the corresponding class.
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
25 ## The function returns the result of the method invocation.
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 18102
diff changeset
26 ##
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
27 ## 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
28 ## 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
29 ## equivalent
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 18102
diff changeset
30 ##
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
31 ## @example
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
32 ## @group
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
33 ## ret = java_invoke (x, "method1", 1.0, "a string")
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
34 ## ret = x.method1 (1.0, "a string")
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
35 ## @end group
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
36 ## @end example
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 18102
diff changeset
37 ##
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
38 ## @seealso{javaMethod, javaObject}
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
39 ## @end deftypefn
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 function retval = java_invoke (obj, methodname, varargin)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
42
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
43 persistent warned = false;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
44 if (! warned)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
45 warned = true;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
46 warning ("Octave:deprecated-function",
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
47 "java_invoke is obsolete and will be removed from a future version of Octave, please use javaMethod instead");
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
48 endif
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 18102
diff changeset
49
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
50 if (nargin < 2)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
51 print_usage ();
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
52 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
53
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
54 retval = javaMethod (methodname, obj, varargin{:});
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
55
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
56 endfunction
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
57