diff options
Diffstat (limited to 'java/src/hdf/hdf5lib/package-info.java')
| -rw-r--r-- | java/src/hdf/hdf5lib/package-info.java | 101 |
1 files changed, 66 insertions, 35 deletions
diff --git a/java/src/hdf/hdf5lib/package-info.java b/java/src/hdf/hdf5lib/package-info.java index 7edfcb2..c04b862 100644 --- a/java/src/hdf/hdf5lib/package-info.java +++ b/java/src/hdf/hdf5lib/package-info.java @@ -11,11 +11,11 @@ * help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - /** * This package is the Java interface for the HDF5 library. * <p> - * This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps a single + * This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps + a single * HDF5 entry point, generally with the arguments and return codes analogous to the C interface. * <p> * For details of the HDF5 library, see the HDF5 Documentation at: @@ -25,7 +25,8 @@ * <b>Mapping of arguments for Java</b> * * <p> - * In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in the HDF + * In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in + the HDF * Reference Manual. * * <table border=1> @@ -66,16 +67,21 @@ * </table> * <b>General Rules for Passing Arguments and Results</b> * <p> - * In general, arguments passed <b>IN</b> to Java are the analogous basic types, as above. The exception is for arrays, + * In general, arguments passed <b>IN</b> to Java are the analogous basic types, as above. The exception is + for arrays, * which are discussed below. * <p> - * The <i>return value</i> of Java methods is also the analogous type, as above. A major exception to that rule is that - * all HDF functions that return SUCCEED/FAIL are declared <i>boolean</i> in the Java version, rather than <i>int</i> as - * in the C. Functions that return a value or else FAIL are declared the equivalent to the C function. However, in most + * The <i>return value</i> of Java methods is also the analogous type, as above. A major exception to that + rule is that + * all HDF functions that return SUCCEED/FAIL are declared <i>boolean</i> in the Java version, rather than + <i>int</i> as + * in the C. Functions that return a value or else FAIL are declared the equivalent to the C function. + However, in most * cases the Java method will raise an exception instead of returning an error code. * See <a href="#ERRORS">Errors and Exceptions</a> below. * <p> - * Java does not support pass by reference of arguments, so arguments that are returned through <b>OUT</b> parameters + * Java does not support pass by reference of arguments, so arguments that are returned through <b>OUT</b> + parameters * must be wrapped in an object or array. The Java API for HDF consistently wraps arguments in arrays. * <p> * For instance, a function that returns two integers is declared: @@ -97,11 +103,13 @@ * </pre> * * <p> - * All the routines where this convention is used will have specific documentation of the details, given below. + * All the routines where this convention is used will have specific documentation of the details, given + below. * <p> * <b>Arrays</b> * <p> - * HDF5 needs to read and write multi-dimensional arrays of any number type (and records). The HDF5 API describes the + * HDF5 needs to read and write multi-dimensional arrays of any number type (and records). The HDF5 API + describes the * layout of the source and destination, and the data for the array passed as a block of bytes, for instance, * * <pre> @@ -109,39 +117,53 @@ * </pre> * * <p> - * where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that is the - * data for a multi-dimensional array. The other parameters describe the dimensions, rank, and datatype of the array on + * where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that + is the + * data for a multi-dimensional array. The other parameters describe the dimensions, rank, and datatype of the + array on * disk (source) and in memory (destination). * <p> - * For Java, this ``ANY'' is a problem, as the type of data must always be declared. Furthermore, multidimensional - * arrays are definitely <i>not</i> laid out contiguously in memory. It would be infeasible to declare a separate + * For Java, this ``ANY'' is a problem, as the type of data must always be declared. Furthermore, + multidimensional + * arrays are definitely <i>not</i> laid out contiguously in memory. It would be infeasible to declare a + separate * routine for every combination of number type and dimensionality. For that reason, the - * <a href="./hdf.hdf5lib.HDFArray.html"><b>HDFArray</b></a> class is used to discover the type, shape, and size of the - * data array at run time, and to convert to and from a contiguous array of bytes in synchronized static native C order. - * <p> - * The upshot is that any Java array of numbers (either primitive or sub-classes of type <b>Number</b>) can be passed as - * an ``Object'', and the Java API will translate to and from the appropriate packed array of bytes needed by the C + * <a href="./hdf.hdf5lib.HDFArray.html"><b>HDFArray</b></a> class is used to discover the type, shape, and + size of the + * data array at run time, and to convert to and from a contiguous array of bytes in synchronized static + native C order. + * <p> + * The upshot is that any Java array of numbers (either primitive or sub-classes of type <b>Number</b>) can be + passed as + * an ``Object'', and the Java API will translate to and from the appropriate packed array of bytes needed by + the C * library. So the function above would be declared: * * <pre> - * public synchronized static native int H5Dread(long fid, long filetype, long memtype, long memspace, Object data); + * public synchronized static native int H5Dread(long fid, long filetype, long memtype, long memspace, Object + data); * </pre> * OPEN_IDS.addElement(id); - * and the parameter <i>data</i> can be any multi-dimensional array of numbers, such as float[][], or int[][][], or + * and the parameter <i>data</i> can be any multi-dimensional array of numbers, such as float[][], or + int[][][], or * Double[][]. * <p> * <b>HDF-5 Constants</b> * <p> - * The HDF-5 API defines a set of constants and enumerated values. Most of these values are available to Java programs - * via the class <a href="./hdf.hdf5lib.HDF5Constants.html"> <b>HDF5Constants</b></a>. For example, the parameters for + * The HDF-5 API defines a set of constants and enumerated values. Most of these values are available to Java + programs + * via the class <a href="./hdf.hdf5lib.HDF5Constants.html"> <b>HDF5Constants</b></a>. For example, the + parameters for * the h5open() call include two numeric values, <b><i>HDFConstants.H5F_ACC_RDWR</i></b> and * <b><i>HDF5Constants.H5P_DEFAULT</i></b>. As would be expected, these numbers correspond to the C constants * <b><i>H5F_ACC_RDWR</i></b> and <b><i>H5P_DEFAULT</i></b>. * <p> - * The HDF-5 API defines a set of values that describe number types and sizes, such as "H5T_NATIVE_INT" and "hsize_t". + * The HDF-5 API defines a set of values that describe number types and sizes, such as "H5T_NATIVE_INT" and + "hsize_t". * These values are determined at run time by the HDF-5 C library. To support these parameters, the Java class - * <a href="./hdf.hdf5lib.HDF5CDataTypes.html"> <b>HDF5CDataTypes</b></a> looks up the values when initiated. The values + * <a href="./hdf.hdf5lib.HDF5CDataTypes.html"> <b>HDF5CDataTypes</b></a> looks up the values when initiated. + The values * can be accessed as public variables of the Java class, such as: * * <pre> @@ -153,22 +175,31 @@ * <p> * <b>Error handling and Exceptions</b> * <p> - * The HDF5 error API (H5E) manages the behavior of the error stack in the HDF-5 library. This API is available from the - * JHI5. Errors are converted into Java exceptions. This is totally different from the C interface, but is very natural + * The HDF5 error API (H5E) manages the behavior of the error stack in the HDF-5 library. This API is + available from the + * JHI5. Errors are converted into Java exceptions. This is totally different from the C interface, but is + very natural * for Java programming. * <p> * The exceptions of the JHI5 are organized as sub-classes of the class - * <a href="./hdf.hdf5lib.exceptions.HDF5Exception.html"> <b>HDF5Exception</b></a>. There are two subclasses of - * <b>HDF5Exception</b>, <a href="./hdf.hdf5lib.exceptions.HDF5LibraryException.html"> <b>HDF5LibraryException</b></a> - * and <a href="./hdf.hdf5lib.exceptions.HDF5JavaException.html"> <b>HDF5JavaException</b></a>. The sub-classes of the - * former represent errors from the HDF-5 C library, while sub-classes of the latter represent errors in the JHI5 + * <a href="./hdf.hdf5lib.exceptions.HDF5Exception.html"> <b>HDF5Exception</b></a>. There are two subclasses + of + * <b>HDF5Exception</b>, <a href="./hdf.hdf5lib.exceptions.HDF5LibraryException.html"> + <b>HDF5LibraryException</b></a> + * and <a href="./hdf.hdf5lib.exceptions.HDF5JavaException.html"> <b>HDF5JavaException</b></a>. The + sub-classes of the + * former represent errors from the HDF-5 C library, while sub-classes of the latter represent errors in the + JHI5 * wrapper and support code. * <p> - * The super-class <b><i>HDF5LibraryException</i></b> implements the method '<b><i>printStackTrace()</i></b>', which - * prints out the HDF-5 error stack, as described in the HDF-5 C API <i><b>H5Eprint()</b>.</i> This may be used by Java + * The super-class <b><i>HDF5LibraryException</i></b> implements the method '<b><i>printStackTrace()</i></b>', + which + * prints out the HDF-5 error stack, as described in the HDF-5 C API <i><b>H5Eprint()</b>.</i> This may be + used by Java * exception handlers to print out the HDF-5 error stack. * <hr> * * <b>See also: <a href="http://hdfgroup.org/HDF5/"> http://hdfgroup.org/HDF5"</a></b> - **/ -package hdf.hdf5lib;
\ No newline at end of file + * + */ +package hdf.hdf5lib; |