ch.systemsx.cisd.hdf5.h5ar

Class ListParameters.ListParametersBuilder

java.lang.Object

ch.systemsx.cisd.hdf5.h5ar.ListParameters.ListParametersBuilder

Enclosing class:

ListParameters

public static final class ListParameters.ListParametersBuilder
extends java.lang.Object

A class for constructing a new list parameters object.

Method Summary

Methods

Modifier and Type	Method and Description
ListParameters.ListParametersBuilder	followSymbolicLinks() Traverse a directory that was resolved from a symbolic link.
ListParameters.ListParametersBuilder	followSymbolicLinks(boolean followSymbolicLinks) If followSymbolicLinks is set to true, traverse a directory that was resolved from a symbolic link, if it is false, do not traverse a directory when it was resolved from a symbolic link.
ListParameters	get() Returns the ListParameters object constructed.
ListParameters.ListParametersBuilder	includeTopLevelDirectoryEntry() Includes the top-level (or starting) directory into the listing.
ListParameters.ListParametersBuilder	includeTopLevelDirectoryEntry(boolean includeTopLevelDirectoryEntry) If includeTopLevelDirectoryEntry is true, includes the top-level directory into the listing, if it is false, exclude the top-level directory from the listing.
ListParameters.ListParametersBuilder	nonRecursive() Perform a non-recursive listing, i.e.
ListParameters.ListParametersBuilder	noReadLinkTarget() Do not read the link target of symbolic links.
ListParameters.ListParametersBuilder	readLinkTargets(boolean readLinkTargets) If readLinkTargets is true, then read the link targets of symbolic links, if it is false, do not read the link targets.
ListParameters.ListParametersBuilder	recursive(boolean recursive) If recursive is true, perform a recursive listing, if it is false, perform a non-recursive listing, i.e.
ListParameters.ListParametersBuilder	resolveSymbolicLinks() Resolve symbolic links to their link targets.
ListParameters.ListParametersBuilder	resolveSymbolicLinks(boolean resolveSymbolicLinks) If resolveSymbolicLinks is true, resolve symbolic links to their link targets, if it is false, do not resolve symbolic links to their link targets.
ListParameters.ListParametersBuilder	suppressDirectoryEntries() Suppress directory entries from being listed.
ListParameters.ListParametersBuilder	suppressDirectoryEntries(boolean suppressDirectoryEntries) If suppressDirectoryEntries is true, suppress directory entries from being listed.
ListParameters.ListParametersBuilder	testArchive() Perform an integrity test of the archive, i.e.
ListParameters.ListParametersBuilder	testArchive(boolean testArchive) If testArchive is true, perform an integrity test of the archive, i.e.

Methods inherited from class java.lang.Object

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

Method Detail

nonRecursive

public ListParameters.ListParametersBuilder nonRecursive()

Perform a non-recursive listing, i.e. do not traverse sub-directories.

recursive

public ListParameters.ListParametersBuilder recursive(boolean recursive)

If recursive is true, perform a recursive listing, if it is false, perform a non-recursive listing, i.e. do not traverse sub-directories.

noReadLinkTarget

public ListParameters.ListParametersBuilder noReadLinkTarget()

Do not read the link target of symbolic links.

readLinkTargets

public ListParameters.ListParametersBuilder readLinkTargets(boolean readLinkTargets)

If readLinkTargets is true, then read the link targets of symbolic links, if it is false, do not read the link targets.

testArchive

public ListParameters.ListParametersBuilder testArchive()

Perform an integrity test of the archive, i.e. see whether the index and the content of the archive match with respect to types, sizes and checksums.

testArchive

public ListParameters.ListParametersBuilder testArchive(boolean testArchive)

If testArchive is true, perform an integrity test of the archive, i.e. see whether the index and the content of the archive match with respect to types, sizes and checksums, if it is false, do not perform an integrity check.

suppressDirectoryEntries

public ListParameters.ListParametersBuilder suppressDirectoryEntries()

Suppress directory entries from being listed. Only files and links will be listed.

suppressDirectoryEntries

public ListParameters.ListParametersBuilder suppressDirectoryEntries(boolean suppressDirectoryEntries)

If suppressDirectoryEntries is true, suppress directory entries from being listed. Only files and links will be listed, if it is false, list also directories.

includeTopLevelDirectoryEntry

public ListParameters.ListParametersBuilder includeTopLevelDirectoryEntry()

Includes the top-level (or starting) directory into the listing.

Note that the root directory "/" will never be listed, so this parameter is only effective when the top-level directory of the listing is not the root directory.

includeTopLevelDirectoryEntry

public ListParameters.ListParametersBuilder includeTopLevelDirectoryEntry(boolean includeTopLevelDirectoryEntry)

If includeTopLevelDirectoryEntry is true, includes the top-level directory into the listing, if it is false, exclude the top-level directory from the listing.

Note that the root directory "/" will never be listed, so this parameter is only effective when the top-level directory of the listing is not the root directory.

resolveSymbolicLinks

public ListParameters.ListParametersBuilder resolveSymbolicLinks()

Resolve symbolic links to their link targets.

This makes symbolic links kind of appear like hard links in the listing. Note, however, that symbolic links to directories being resolved do not lead to the directory being traversed expect if also followSymbolicLinks() is given.

resolveSymbolicLinks

public ListParameters.ListParametersBuilder resolveSymbolicLinks(boolean resolveSymbolicLinks)

If resolveSymbolicLinks is true, resolve symbolic links to their link targets, if it is false, do not resolve symbolic links to their link targets.

If set to true, this makes symbolic links kind of appear like hard links in the listing. Note, however, that symbolic links to directories being resolved do not lead to the directory being traversed expect if also followSymbolicLinks() is given.

followSymbolicLinks

public ListParameters.ListParametersBuilder followSymbolicLinks()

Traverse a directory that was resolved from a symbolic link.

Only effective if recursive listing is enabled.

followSymbolicLinks

public ListParameters.ListParametersBuilder followSymbolicLinks(boolean followSymbolicLinks)

If followSymbolicLinks is set to true, traverse a directory that was resolved from a symbolic link, if it is false, do not traverse a directory when it was resolved from a symbolic link.

Only effective if recursive listing is enabled.

get

public ListParameters get()

Returns the ListParameters object constructed.