Module org.hdfgroup.object

Package hdf.object.h5

Class H5Plugins

Object

hdf.object.h5.H5Plugins

public final class H5Plugins
extends Object

HDF5 plugin utility class

Constructor Summary

Constructors

Constructor	Description
H5Plugins()	Creates a list of plugin paths for HDFView.

Method Summary

Modifier and Type	Method	Description
static void	appendPluginPath(String pluginPath)	Append the plugin path.
static void	deletePluginPath(int pathIndex)	Removes the plugin path.
static final ArrayList<String>	getPluginPaths()	Get the list of paths for the HDF5 library.
static final long	getTotalPluginPaths()	Get the total number of paths for the HDF5 library.
static void	insertPluginPath(String pluginPath, int pathIndex)	Inserts the plugin path.
static void	prependPluginPath(String pluginPath)	Prepend the plugin path.
static void	replacePluginPath(String pluginPath, int pathIndex)	Replaces the plugin path.

Methods inherited from class java.lang.Object

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

Constructor Details

H5Plugins

public H5Plugins()

Creates a list of plugin paths for HDFView.

Method Details

getTotalPluginPaths

public static final long getTotalPluginPaths()
                                      throws hdf.hdf5lib.exceptions.HDF5Exception

Get the total number of paths for the HDF5 library.

Returns:

total number of plugin paths

Throws:

hdf.hdf5lib.exceptions.HDF5Exception - If there is an error at the HDF5 library level.

getPluginPaths

public static final ArrayList<String> getPluginPaths()
                                              throws hdf.hdf5lib.exceptions.HDF5Exception

Get the list of paths for the HDF5 library.

Returns:

list of plugin paths

Throws:

hdf.hdf5lib.exceptions.HDF5Exception - If there is an error at the HDF5 library level.

replacePluginPath

public static void replacePluginPath(String pluginPath,
 int pathIndex)
                              throws hdf.hdf5lib.exceptions.HDF5Exception

Replaces the plugin path.

Parameters:

pluginPath - The plugin path.

pathIndex - The index to replace the plugin path.

Throws:

hdf.hdf5lib.exceptions.HDF5Exception

insertPluginPath

public static void insertPluginPath(String pluginPath,
 int pathIndex)
                             throws hdf.hdf5lib.exceptions.HDF5Exception

Inserts the plugin path.

Parameters:

pluginPath - The plugin path.

pathIndex - The index to insert the plugin path.

Throws:

hdf.hdf5lib.exceptions.HDF5Exception

deletePluginPath

public static void deletePluginPath(int pathIndex)
                             throws hdf.hdf5lib.exceptions.HDF5Exception

Removes the plugin path.

Parameters:

pathIndex - The index to remove the plugin path.

Throws:

hdf.hdf5lib.exceptions.HDF5Exception

prependPluginPath

public static void prependPluginPath(String pluginPath)
                              throws hdf.hdf5lib.exceptions.HDF5Exception

Prepend the plugin path.

Parameters:

pluginPath - The plugin path.

Throws:

hdf.hdf5lib.exceptions.HDF5Exception

appendPluginPath

public static void appendPluginPath(String pluginPath)
                             throws hdf.hdf5lib.exceptions.HDF5Exception

Append the plugin path.

Parameters:

pluginPath - The plugin path.

Throws:

hdf.hdf5lib.exceptions.HDF5Exception