HDF5ObjectInformation (jhdf5 19.04.1 API)

java.lang.Object
- ch.systemsx.cisd.hdf5.HDF5ObjectInformation

public final class HDF5ObjectInformation
extends java.lang.Object

Information about an object in an HDF5 file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkExists()`
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`exists()` Returns `true`, if the link exists.
`long`	`getAddress()` Returns the address of the object in the file.
`long`	`getCreationTime()` Returns the time of creation of this object (as number of seconds since start of the epoch).
`long`	`getFileNumber()` Returns the file number that the object is in.
`java.lang.String`	`getName()` Returns the name of this link in the HDF5 file (the path without the parent).
`long`	`getNumberOfAttributes()` Returns the number of attributes that is object has.
`java.lang.String`	`getParentPath()` Returns the parent of the path of this link the HDF5 file.
`java.lang.String`	`getPath()` Returns the path of this link in the HDF5 file.
`int`	`getReferenceCount()` Returns the number of references that point to this object.
`HDF5ObjectType`	`getType()` Returns the type of this link.
`int`	`hashCode()`
`boolean`	`isDataSet()` Returns `true`, if the link is a data set.
`boolean`	`isDataType()` Returns `true`, if the link is a data type.
`boolean`	`isGroup()` Returns `true`, if the link is a group.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getFileNumber
```
public long getFileNumber()
```
    Returns the file number that the object is in. Can be useful when external links are involved.
  - getAddress
```
public long getAddress()
```
    Returns the address of the object in the file. If the address of two links is the same, then they point to the same object. Can be used to spot hard or soft links.
  - getReferenceCount
```
public int getReferenceCount()
```
    Returns the number of references that point to this object. (Number of hard links that point to the object).
  - getCreationTime
```
public long getCreationTime()
```
    Returns the time of creation of this object (as number of seconds since start of the epoch). Note that this only works for data set, for groups, this will always return 0.
  - getNumberOfAttributes
```
public long getNumberOfAttributes()
```
    Returns the number of attributes that is object has.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - checkExists
```
public void checkExists()
                 throws HDF5JavaException
```
    Throws:
    
    HDF5JavaException - If the link does not exist.
  - getPath
```
public java.lang.String getPath()
```
    Returns the path of this link in the HDF5 file.
  - getParentPath
```
public java.lang.String getParentPath()
```
    Returns the parent of the path of this link the HDF5 file. If this link corresponds to the root, then this method will return the root ("/") itself.
  - getName
```
public java.lang.String getName()
```
    Returns the name of this link in the HDF5 file (the path without the parent).
  - getType
```
public HDF5ObjectType getType()
```
    Returns the type of this link.
  - exists
```
public boolean exists()
```
    Returns true, if the link exists.
  - isGroup
```
public boolean isGroup()
```
    Returns true, if the link is a group.
  - isDataSet
```
public boolean isDataSet()
```
    Returns true, if the link is a data set.
  - isDataType
```
public boolean isDataType()
```
    Returns true, if the link is a data type.

Class HDF5ObjectInformation

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFileNumber

getAddress

getReferenceCount

getCreationTime

getNumberOfAttributes

hashCode

equals

checkExists

getPath

getParentPath

getName

getType

exists

isGroup

isDataSet

isDataType