Deprecated API

Contents

• Deprecated Methods
• Deprecated Constructors

Deprecated Methods

ncsa.hdf.object.Dataset.convertFromUnsignedC(Object)
Not for public use in the future.
Using Dataset.convertFromUnsignedC(Object, Object)

ncsa.hdf.object.Dataset.convertToUnsignedC(Object)
Not for public use in the future.
Using Dataset.convertToUnsignedC(Object, Object)

ncsa.hdf.object.CompoundDS.copy(Group, String, long[], Object)
Not implemented for compound dataset.

ncsa.hdf.object.FileFormat.copy(HObject, Group)
As of 2.4, replaced by FileFormat.copy(HObject, Group, String)

To mimic the behavior originally provided by this method, call the replacement method with null as the 3rd parameter.

ncsa.hdf.object.FileFormat.create(String)
As of 2.4, replaced by FileFormat.createFile(String, int)

The replacement method has an additional parameter that controls the behavior if the file already exists. Use FileFormat.FILE_CREATE_DELETE as the second argument in the replacement method to mimic the behavior originally provided by this method.

ncsa.hdf.object.h5.H5CompoundDS.create(String, Group, long[], String[], Datatype[], int[], int[][], Object)
Not for public use in the future.
Using H5CompoundDS.create(String, Group, long[], long[], long[], int, String[], Datatype[], int[], int[][], Object)

ncsa.hdf.object.h5.H5CompoundDS.create(String, Group, long[], String[], Datatype[], int[], Object)
Not for public use in the future.
Using H5CompoundDS.create(String, Group, long[], long[], long[], int, String[], Datatype[], int[], int[][], Object)

ncsa.hdf.object.FileFormat.createCompoundDS(String, Group, long[], String[], Datatype[], int[], Object)
As of 2.4, replaced by FileFormat.createCompoundDS(String, Group, long[], long[], long[], int, String[], Datatype[], int[], Object)

The replacement method has additional parameters: maxdims, chunks, and gzip. To mimic the behavior originally provided by this method, call the replacement method with the following parameter list: ( name, pgroup, dims, null, null, -1, memberNames, memberDatatypes, memberSizes, data );

ncsa.hdf.object.FileFormat.getHObject(String)
As of 2.4, replaced by FileFormat.get(String)

This static method, which as been deprecated, causes two problems:

• It can be very expensive if it is called many times or in a loop because each call to the method creates an instance of a file.
• Since the method does not return the instance of the file, the file cannot be closed directly and may be left open (memory leak). The only way to close the file is through the object returned by this method.

ncsa.hdf.object.FileFormat.getHObject(String, String)
As of 2.4, replaced by FileFormat.get(String)

This static method, which as been deprecated, causes two problems:

• It can be very expensive if it is called many times or in a loop because each call to the method creates an instance of a file.
• Since the method does not return the instance of the file, the file cannot be closed directly and may be left open (memory leak). The only way to close the file is through the object returned by this method, for example:

   Dataset dset = H5File.getObject("hdf5_test.h5", "/images/iceburg");
   ...
   // close the file through dset
   dset.getFileFormat().close();
   

ncsa.hdf.object.FileFormat.open(String, int)
As of 2.4, replaced by FileFormat.createInstance(String, int) The replacement method has identical functionality and a more descriptive name. Since open is used elsewhere to perform a different function this method has been deprecated.

ncsa.hdf.object.Dataset.setData(Object)
Not for public use in the future.

setData() is not safe to use because it changes memory buffer of the dataset object. Dataset operation such as write/read will fail if the buffer type or size is changed.

ncsa.hdf.object.h5.H5Datatype.toNative(int)
Not for public use in the future.
Using H5.H5Tget_native_type(int)

Return the HDF5 memory datatype identifier based on the HDF5 datatype identifier on disk

Deprecated Constructors

ncsa.hdf.object.CompoundDS(FileFormat, String, String, long[])
Not for public use in the future.
Using CompoundDS.CompoundDS(FileFormat, String, String)

ncsa.hdf.object.Dataset(FileFormat, String, String, long[])
Not for public use in the future.
Using Dataset.Dataset(FileFormat, String, String)

ncsa.hdf.object.Datatype(FileFormat, String, String, long[])
Not for public use in the future.
Using Datatype.Datatype(FileFormat, String, String)

ncsa.hdf.object.Group(FileFormat, String, String, Group, long[])
Not for public use in the future.
Using Group.Group(FileFormat, String, String, Group)

ncsa.hdf.object.h5.H5CompoundDS(FileFormat, String, String, long[])
Not for public use in the future.
Using H5CompoundDS.H5CompoundDS(FileFormat, String, String)

ncsa.hdf.object.h5.H5Datatype(FileFormat, String, String, long[])
Not for public use in the future.
Using H5Datatype.H5Datatype(FileFormat, String, String)

ncsa.hdf.object.h5.H5Group(FileFormat, String, String, Group, long[])
Not for public use in the future.
Using H5Group.H5Group(FileFormat, String, String, Group)

ncsa.hdf.object.h5.H5ScalarDS(FileFormat, String, String, long[])
Not for public use in the future.
Using H5ScalarDS.H5ScalarDS(FileFormat, String, String)

ncsa.hdf.object.HObject(FileFormat, String, String, long[])
Not for public use in the future.
Using HObject.HObject(FileFormat, String, String)

ncsa.hdf.object.ScalarDS(FileFormat, String, String, long[])
Not for public use in the future.
Using ScalarDS.ScalarDS(FileFormat, String, String)