view scripts/java/javaArray.m @ 15748:54e8c2527a9e

style and doc fixes for newly imported Java package .m files * java/cell2mlstr.m, java/errordlg.m, java/helpdlg.m, java/inputdlg.m, java/javaArray.m, java/javaaddpath.m, java/javaclasspath.m, java/javafields.m, java/javamem.m, java/javamethods.m, java/javarmpath.m, java/listdlg.m, java/msgbox.m java/questdlg.m, java/warndlg.m: Style and doc fixes.
author John W. Eaton <jwe@octave.org>
date Fri, 07 Dec 2012 17:21:27 -0500
parents da26f72408a7
children 54f7ef3f7e63
line wrap: on
line source

## Copyright (C) 2007 Michael Goffioul
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function file} {@var{a} =} javaArray (@var{class}, @var{[M,N,...]})
## @deftypefnx {Function file} {@var{a} =} javaArray (@var{class}, @var{M}, @var{N}, @dots{})
##
## Creates a Java array of size @code{[@var{M}, @var{N}, @dots{}]} with
## elements of class @var{class}.  @var{class} may be a Java object
## representing a class or a string containing the fully qualified class name.
##
## The generated array is uninitialized, all elements are set to null
## if @var{class} is a reference type, or to a default value (usually 0)
## if @var{class} is a primitive type.
##
## @example
## a = javaArray ("java.lang.String", 2, 2);
## a(1,1) = "Hello";
## @end example
## @end deftypefn

function retval = javaArray (class_name, varargin)

  switch length (varargin)
    case 0
      error ("missing array size");

    case 1
      dims = varargin{1};

    otherwise
      dims = [varargin{:}];
  endswitch

  retval = java_invoke ("org.octave.ClassHelper", "createArray",
                        class_name, dims);

endfunction