Package org.anchoranalysis.plugin.io.bean.input.files.provider

Class DirectoryDepth

Object

AnchorBean<FilesProvider>

FilesProvider

FilesProviderWithDirectory

FilesProviderWithDirectoryString

DirectoryDepth

public class DirectoryDepth
extends FilesProviderWithDirectoryString

Lists all directories to a certain depth

Constructor Summary

Constructors

Constructor	Description
DirectoryDepth()

Method Summary

Modifier and Type	Method	Description
int	getExactDepth()
List<File>	matchingFilesForDirectory(Path directory, InputManagerParameters parameters)	The matching files for this provider that exist in a particular directory.
void	setExactDepth(int exactDepth)

Methods inherited from class org.anchoranalysis.io.input.bean.files.FilesProviderWithDirectoryString

getDirectory, getDirectoryAsPath, isLocalized, setDirectory, setLocalized

Methods inherited from class org.anchoranalysis.io.input.bean.files.FilesProviderWithDirectory

create, getDirectoryAsPathEnsureAbsolute, rootDirectory

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryDepth

public DirectoryDepth()

Method Details

matchingFilesForDirectory

public List<File> matchingFilesForDirectory(Path directory,
 InputManagerParameters parameters)
                                     throws FilesProviderException

Description copied from class: FilesProviderWithDirectory

The matching files for this provider that exist in a particular directory.

This directory may or may not be searched recursively, depending on implementation.

Specified by:

matchingFilesForDirectory in class FilesProviderWithDirectory

Parameters:

directory - the directory.

parameters - parameters passed to an InputManager to generate input-objects.

Returns:

a newly created list of matching files.

Throws:

FilesProviderException - if the operation is unable to complete successfully.

getExactDepth

public int getExactDepth()

setExactDepth

public void setExactDepth(int exactDepth)