# Deprecated API

## Contents

- Methods
- Constructors

- Methods
  Method
  Description
  hdf.object.CompoundDS.copy​(Group, String, long[], Object)
  Not implemented for compound dataset.
  hdf.object.Dataset.convertFromUnsignedC​(Object)
  Not for public use in the future.
  Using `Dataset.convertFromUnsignedC(Object, Object)`
  hdf.object.Dataset.convertToUnsignedC​(Object)
  Not for public use in the future.
  Using `Dataset.convertToUnsignedC(Object, Object)`
  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.

  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.

  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 );`

  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.
  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();

  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.
  hdf.object.h5.H5CompoundDS.create​(String, Group, long[], String[], Datatype[], int[], long[][], Object)
  Not for public use in the future.
  Using `H5CompoundDS.create(String, Group, long[], long[], long[], int, String[], Datatype[], int[], long[][], Object)`
  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[], long[][], Object)`

- Constructors
  Constructor
  Description
  hdf.object.CompoundDS​(FileFormat, String, String, long[])
  Not for public use in the future.
  Using `CompoundDS(FileFormat, String, String)`
  hdf.object.Dataset​(FileFormat, String, String, long[])
  Not for public use in the future.
  Using `Dataset(FileFormat, String, String)`
  hdf.object.Datatype​(FileFormat, String, String, long[])
  Not for public use in the future.
  Using `Datatype(FileFormat, String, String)`
  hdf.object.Group​(FileFormat, String, String, Group, long[])
  Not for public use in the future.
  Using `Group(FileFormat, String, String, Group)`
  hdf.object.h5.H5CompoundDS​(FileFormat, String, String, long[])
  Not for public use in the future.
  Using `H5CompoundDS(FileFormat, String, String)`
  hdf.object.h5.H5Datatype​(FileFormat, String, String, long[])
  Not for public use in the future.
  Using `H5Datatype(FileFormat, String, String)`
  hdf.object.h5.H5Group​(FileFormat, String, String, Group, long[])
  Not for public use in the future.
  Using `H5Group(FileFormat, String, String, Group)`
  hdf.object.h5.H5ScalarDS​(FileFormat, String, String, long[])
  Not for public use in the future.
  Using `H5ScalarDS(FileFormat, String, String)`
  hdf.object.HObject​(FileFormat, String, String, long[])
  hdf.object.ScalarDS​(FileFormat, String, String, long[])
  Not for public use in the future.
  Using `ScalarDS(FileFormat, String, String)`