annotate scripts/miscellaneous/usejava.m @ 14200:64d9f33313cc stable rc-3-6-0-1

3.6.0-rc1 release candidate * configure.ac (AC_INIT): Version is now 3.6.0-rc1. (OCTAVE_RELEASE_DATE): Now 2012-01-12.
author John W. Eaton <jwe@octave.org>
date Thu, 12 Jan 2012 14:31:50 -0500
parents 72c96de7a403
children 937035390ec0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14093
diff changeset
1 ## Copyright (C) 2012 Rik Wehbring
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
2 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
3 ## This file is part of Octave.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
4 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
8 ## your option) any later version.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
9 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
13 ## General Public License for more details.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
14 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
18
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
19 ## -*- texinfo -*-
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
20 ## @deftypefn {Function File} {} usejava (@var{feature})
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
21 ## Return true if the specific Sun Java element @var{feature} is available.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
22 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
23 ## Possible features are:
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
24 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
25 ## @table @asis
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
26 ## @item "awt"
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
27 ## Abstract Window Toolkit for GUIs.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
28 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
29 ## @item "desktop"
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
30 ## Interactive desktop is running.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
31 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
32 ## @item "jvm"
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
33 ## Java Virtual Machine.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
34 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
35 ## @item "swing"
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
36 ## Swing components for lightweight GUIs.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
37 ## @end table
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
38 ##
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 13826
diff changeset
39 ## This function is provided for compatibility with @sc{matlab} scripts which
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
40 ## may alter their behavior based on the availability of Java. Octave does
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
41 ## not implement an interface to Java and this function always returns
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
42 ## @code{false}.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
43 ## @end deftypefn
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
44
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
45 function retval = usejava (feature)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
46
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
47 if (nargin != 1 || ! ischar (feature))
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
48 print_usage ();
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
49 endif
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
50
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
51 if (! any (strcmp (feature, {"awt", "desktop", "jvm", "swing"})))
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
52 error ("usejava: unrecognized feature '%s'", feature);
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
53 endif
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
54
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
55 retval = false;
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
56
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
57 endfunction
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
58
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
59
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
60 %!assert (usejava ("awt"), false)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
61
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
62 %% Test input validation
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
63 %!error usejava ()
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
64 %!error usejava (1, 2)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
65 %!error usejava (1)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
66 %!error <unrecognized feature> usejava ("abc")
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
67