Package hdf.hdf5lib

Class HDF5GroupInfo

  • @Deprecated
public class HDF5GroupInfo
extends java.lang.Object
    Deprecated.
    Not for public use. It is not used by the library. This class assumes that an object can contain four values which uniquely identify an object among those HDF5 files which are open. This is no longer valid in future HDF5 releases.

    This class is a container for the information reported about an HDF5 Object from the H5Gget_obj_info() method.

    The fileno and objno fields contain four values which uniquely identify an object among those HDF5 files which are open: if all four values are the same between two objects, then the two objects are the same (provided both files are still open). The nlink field is the number of hard links to the object or zero when information is being returned about a symbolic link (symbolic links do not have hard links but all other objects always have at least one). The type field contains the type of the object, one of H5G_GROUP, H5G_DATASET, or H5G_LINK. The mtime field contains the modification time. If information is being returned about a symbolic link then linklen will be the length of the link value (the name of the pointed-to object with the null terminator); otherwise linklen will be zero. Other fields may be added to this structure in the future.

    • Constructor Summary

      Constructors 
      Constructor Description
      HDF5GroupInfo()
      Deprecated.
      Container for the information reported about an HDF5 Object from the H5Gget_obj_info() method

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Deprecated.
      The fileno and objno fields contain four values which uniquely identify an object among those HDF5 files.
      long[] getFileno()
      Deprecated.
      fileno accessors
      int getLinklen()
      Deprecated.
      accessors
      long getMtime()
      Deprecated.
      accessors
      int getNlink()
      Deprecated.
      accessors
      long[] getObjno()
      Deprecated.
      accessors
      long getOID()
      Deprecated.
      Returns the object id.
      int getType()
      Deprecated.
      accessors
      void reset()
      Deprecated.
      Resets all the group information to defaults.
      void setGroupInfo​(long[] fn, long[] on, int nl, int t, long mt, int len)
      Deprecated.
      Sets the HDF5 group information.
      java.lang.String toString()
      Deprecated.
      /** Converts this object to a String representation.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • HDF5GroupInfo

        public HDF5GroupInfo()
        Deprecated.
        Container for the information reported about an HDF5 Object from the H5Gget_obj_info() method

    • Method Detail

      • setGroupInfo

        public void setGroupInfo​(long[] fn,
                         long[] on,
                         int nl,
                         int t,
                         long mt,
                         int len)
        Deprecated.
        Sets the HDF5 group information. Used by the JHI5.
        Parameters:
        fn - File id number
        on - Object id number
        nl - Number of links
        t - Type of the object
        mt - Modification time
        len - Length of link

      • reset

        public void reset()
        Deprecated.
        Resets all the group information to defaults.

      • getFileno

        public long[] getFileno()
        Deprecated.
        fileno accessors
        Returns:
        the file number if successful

      • getObjno

        public long[] getObjno()
        Deprecated.
        accessors
        Returns:
        the object number if successful

      • getType

        public int getType()
        Deprecated.
        accessors
        Returns:
        type of group if successful

      • getNlink

        public int getNlink()
        Deprecated.
        accessors
        Returns:
        the number of links in the group if successful

      • getMtime

        public long getMtime()
        Deprecated.
        accessors
        Returns:
        the modified time value if successful

      • getLinklen

        public int getLinklen()
        Deprecated.
        accessors
        Returns:
        a length of link name if successful

      • equals

        public boolean equals​(java.lang.Object obj)
        Deprecated.
        The fileno and objno fields contain four values which uniquely identify an object among those HDF5 files.
        Overrides:
        equals in class java.lang.Object

      • getOID

        public long getOID()
        Deprecated.
        Returns the object id.
        Returns:
        the object id

      • toString

        public java.lang.String toString()
        Deprecated.
        /** Converts this object to a String representation.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this object