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

Class FilesProviderWithDirectoryString

Object

AnchorBean<FilesProvider>

FilesProvider

FilesProviderWithDirectory

FilesProviderWithDirectoryString

Direct Known Subclasses:

DirectoryDepth, FileSetFromStringSet, SearchDirectory

public abstract class FilesProviderWithDirectoryString
extends FilesProviderWithDirectory

A FilesProviderWithDirectory where the directory is optionally specified as a string constant

If an explicit absolute directory is set then it is used. Otherwise a directory is inferred by trying in order of priority:

• The directory in which the bean-XML file is located (iff localized==true)
• The input-directory set in the input context
• The current working-directory

If an explicit relative directory it is not normalized (unless localized==true, in which case it is resolved against the location of the BeanXML).

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FilesProviderWithDirectoryString()

Method Summary

Modifier and Type	Method	Description
String	getDirectory()	A directory in which to look for files.
Path	getDirectoryAsPath(InputContextParameters inputContext)	The associated directory with the list of files.
boolean	isLocalized()	When true paths are resolved against the location of the associated BeanXML file.
void	setDirectory(String directory)	A directory in which to look for files.
void	setLocalized(boolean localized)	When true paths are resolved against the location of the associated BeanXML file.

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

create, getDirectoryAsPathEnsureAbsolute, matchingFilesForDirectory, 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

FilesProviderWithDirectoryString

public FilesProviderWithDirectoryString()

Method Details

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.

getDirectory

public String getDirectory()

A directory in which to look for files. If set, takes precedence over any other inference of a directory.

setDirectory

public void setDirectory(String directory)

A directory in which to look for files. If set, takes precedence over any other inference of a directory.

isLocalized

public boolean isLocalized()

When true paths are resolved against the location of the associated BeanXML file.

setLocalized

public void setLocalized(boolean localized)

When true paths are resolved against the location of the associated BeanXML file.