ch.systemsx.cisd.hdf5.h5ar

Interface IHDF5ArchiveInfoProvider

All Known Subinterfaces:

IHDF5Archiver, IHDF5ArchiveReader

public interface IHDF5ArchiveInfoProvider

An info provider for HDF5 archives.

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String path) Returns true, if an entry path exists in the archive.
boolean	isDirectory(java.lang.String path) Returns true, if a directory entry path exists in the archive.
boolean	isRegularFile(java.lang.String path) Returns true, if a regular file entry path exists in the archive.
boolean	isSymLink(java.lang.String path) Returns true, if a symbolic link entry path exists in the archive.
java.util.List<ArchiveEntry>	list() Returns the list of all entries in the archive recursively.
java.util.List<ArchiveEntry>	list(java.lang.String fileOrDir) Returns the list of all entries below fileOrDir in the archive recursively.
IHDF5ArchiveInfoProvider	list(java.lang.String fileOrDir, IArchiveEntryVisitor visitor) Returns the list of all entries below fileOrDir in the archive recursively.
IHDF5ArchiveInfoProvider	list(java.lang.String fileOrDir, IArchiveEntryVisitor visitor, ListParameters params) Returns the list of entries below fileOrDir in the archive.
java.util.List<ArchiveEntry>	list(java.lang.String fileOrDir, ListParameters params) Returns the list of entries below fileOrDir in the archive.
java.util.List<ArchiveEntry>	test() Performs an integrity of the archive.
ArchiveEntry	tryGetEntry(java.lang.String path, boolean readLinkTarget) Returns an archive entry for path, or null, if the archive has no archive entry for this path.
ArchiveEntry	tryGetResolvedEntry(java.lang.String path, boolean keepPath) Returns the archive entry for path.
ArchiveEntry	tryResolveLink(ArchiveEntry entry) Resolves the symbolic link of entry, if any.

Method Detail

exists

boolean exists(java.lang.String path)

Returns true, if an entry path exists in the archive.

Parameters:

path - The path to obtain information for.

isDirectory

boolean isDirectory(java.lang.String path)

Returns true, if a directory entry path exists in the archive.

Parameters:

path - The path to obtain information for.

isRegularFile

boolean isRegularFile(java.lang.String path)

Returns true, if a regular file entry path exists in the archive.

Parameters:

path - The path to obtain information for.

isSymLink

boolean isSymLink(java.lang.String path)

Returns true, if a symbolic link entry path exists in the archive.

Parameters:

path - The path to obtain information for.

tryGetEntry

ArchiveEntry tryGetEntry(java.lang.String path,
                         boolean readLinkTarget)

Returns an archive entry for path, or null, if the archive has no archive entry for this path.

Parameters:

path - The path to obtain information for.

readLinkTarget - If true and if the entry is a symbolic link entry, read the link target.

tryResolveLink

ArchiveEntry tryResolveLink(ArchiveEntry entry)

Resolves the symbolic link of entry, if any.

Parameters:

entry - The archive entry to resolve.

Returns:

The resolved link, if entry is a symbolic link that links to an existing file or directory target, null if entry is a symbolic link that links to a non-existing target, or entry, if this is not a link.

tryGetResolvedEntry

ArchiveEntry tryGetResolvedEntry(java.lang.String path,
                                 boolean keepPath)

Returns the archive entry for path. If path is a symbolic link, the entry will be resolved to the real file or directory in the archive, or null, if the link target doesn't exist.

Parameters:

path - The path in the archive to get the entry for.

keepPath - If true, the resolved entry will keep the path, i.e. the returned entry of a symlink will look like a hard link. If false, the returned entry will be the entry of the resolved path.

Returns:

The resolved link, if path denotes a file, directory, or symbolic link that links to an existing file or directory target, null if path denotes a symbolic link that links to a non-existing target.

list

java.util.List<ArchiveEntry> list()

Returns the list of all entries in the archive recursively.

Returns:

The list of archive entries.

list

java.util.List<ArchiveEntry> list(java.lang.String fileOrDir)

Returns the list of all entries below fileOrDir in the archive recursively.

Parameters:

fileOrDir - The file to list or the directory to list the entries from recursively.

Returns:

The list of archive entries.

list

java.util.List<ArchiveEntry> list(java.lang.String fileOrDir,
                                  ListParameters params)

Returns the list of entries below fileOrDir in the archive.

Parameters:

fileOrDir - The file to list or the directory to list the entries from.

params - the parameters to modify the listing behavior.

Returns:

The list of archive entries.

list

IHDF5ArchiveInfoProvider list(java.lang.String fileOrDir,
                              IArchiveEntryVisitor visitor)

Returns the list of all entries below fileOrDir in the archive recursively.

Parameters:

fileOrDir - The file to list or the directory to list the entries from recursively.

visitor - The archive entry visitor to call for each entry.

Returns:

This archive info provider.

list

IHDF5ArchiveInfoProvider list(java.lang.String fileOrDir,
                              IArchiveEntryVisitor visitor,
                              ListParameters params)

Returns the list of entries below fileOrDir in the archive.

Parameters:

fileOrDir - The file to list or the directory to list the entries from.

visitor - The archive entry visitor to call for each entry.

params - the parameters to modify the listing behavior.

Returns:

This archive info provider.

test

java.util.List<ArchiveEntry> test()

Performs an integrity of the archive.

Returns:

All entries which failed the integrity check.