ch.systemsx.cisd.hdf5.h5ar

Class ListParameters

java.lang.Object

ch.systemsx.cisd.hdf5.h5ar.ListParameters

public final class ListParameters
extends java.lang.Object

A class that represents parameters for HDF5Archiver.list(String, ListParameters).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListParameters.ListParametersBuilder A class for constructing a new list parameters object.

Field Summary

Fields

Modifier and Type	Field and Description
static ListParameters	DEFAULT The default list parameters: recursive does not test the integrity of the archive does not suppress directory entries exclude the top-level directory reads symbolic link targets does not resolve symbolic links does not follow symbolic links
static ListParameters	TEST The list parameters for testing the archive integrity: recursive tests the integrity of the archive does not suppress directory entries includes the top-level directory reads symbolic link targets does not resolve symbolic links does not follow symbolic links

Method Summary

Modifier and Type	Method and Description
static ListParameters.ListParametersBuilder	build() Starts building new list parameters.
boolean	isFollowSymbolicLinks() Returns if directories resolved from symbolic links should be traversed.
boolean	isIncludeTopLevelDirectoryEntry() Returns if the top-level directory entry should be listed as well.
boolean	isReadLinkTargets() Returns if symbolic link targets should be read.
boolean	isRecursive() Returns if recursive listing is enabled, i.e.
boolean	isResolveSymbolicLinks() Returns if symbolic links should be resolved.
boolean	isSuppressDirectoryEntries() Returns if directory entries should be suppressed from being listed.
boolean	isTestArchive() Returns if the archive should be tested for integrity.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ListParameters DEFAULT

The default list parameters:

• recursive
• does not test the integrity of the archive
• does not suppress directory entries
• exclude the top-level directory
• reads symbolic link targets
• does not resolve symbolic links
• does not follow symbolic links

TEST

public static final ListParameters TEST

The list parameters for testing the archive integrity:

• recursive
• tests the integrity of the archive
• does not suppress directory entries
• includes the top-level directory
• reads symbolic link targets
• does not resolve symbolic links
• does not follow symbolic links

Method Detail

build

public static ListParameters.ListParametersBuilder build()

Starts building new list parameters.

Returns:

A new ListParameters.ListParametersBuilder.

isRecursive

public boolean isRecursive()

Returns if recursive listing is enabled, i.e. if the listing will traverse into sub-directories.

See Also:

ListParameters.ListParametersBuilder.recursive(boolean)

isReadLinkTargets

public boolean isReadLinkTargets()

Returns if symbolic link targets should be read.

See Also:

ListParameters.ListParametersBuilder.readLinkTargets(boolean)

isTestArchive

public boolean isTestArchive()

Returns if the archive should be tested for integrity.

See Also:

ListParameters.ListParametersBuilder.testArchive(boolean)

isSuppressDirectoryEntries

public boolean isSuppressDirectoryEntries()

Returns if directory entries should be suppressed from being listed.

See Also:

ListParameters.ListParametersBuilder.suppressDirectoryEntries(boolean)

isIncludeTopLevelDirectoryEntry

public boolean isIncludeTopLevelDirectoryEntry()

Returns if the top-level directory entry should be listed as well.

See Also:

ListParameters.ListParametersBuilder.includeTopLevelDirectoryEntry(boolean)

isResolveSymbolicLinks

public boolean isResolveSymbolicLinks()

Returns if symbolic links should be resolved.

See Also:

ListParameters.ListParametersBuilder.resolveSymbolicLinks(boolean)

isFollowSymbolicLinks

public boolean isFollowSymbolicLinks()

Returns if directories resolved from symbolic links should be traversed.

See Also:

ListParameters.ListParametersBuilder.followSymbolicLinks(boolean)