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

Class SingleFile

Object

org.anchoranalysis.bean.AnchorBean<FilesProvider>

org.anchoranalysis.io.input.bean.files.FilesProvider

org.anchoranalysis.io.input.bean.files.FilesProviderWithDirectory

org.anchoranalysis.io.input.bean.files.SingleFile

public class SingleFile
extends FilesProviderWithDirectory

Provides a single file only.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
SingleFile()
SingleFile(String path)	Creates with a path for the single-file.

Method Summary

Modifier and Type	Method	Description
Path	getDirectoryAsPath(InputContextParameters inputContext)	The associated directory with the list of files.
String	getPath()	The path of the single-file.
List<File>	matchingFilesForDirectory(Path directory, InputManagerParameters parameters)	The matching files for this provider that exist in a particular directory.

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

SingleFile

public SingleFile(String path)

Creates with a path for the single-file.

Parameters:

path - the path.

SingleFile

public SingleFile()

Method Details

matchingFilesForDirectory

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

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.

getDirectoryAsPath

public Path getDirectoryAsPath(InputContextParameters inputContext)

Description copied from class: FilesProviderWithDirectory

The associated directory with the list of files.

Specified by:

getDirectoryAsPath in class FilesProviderWithDirectory

Parameters:

inputContext - the input-context.

Returns:

the associated directory, as a path.

getPath

public String getPath()

The path of the single-file.