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

Class FilesProviderWithoutDirectory

Object

org.anchoranalysis.bean.AnchorBean<FilesProvider>

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

org.anchoranalysis.io.input.bean.files.FilesProviderWithoutDirectory

public abstract class FilesProviderWithoutDirectory
extends FilesProvider

Base class for implementations of FilesProvider which do not have an associated directory.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FilesProviderWithoutDirectory()

Method Summary

Modifier and Type	Method	Description
Optional<Path>	rootDirectory(InputContextParameters inputContext)	A root directory for these files, if it exists.

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

create

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

FilesProviderWithoutDirectory

public FilesProviderWithoutDirectory()

Method Details

rootDirectory

public Optional<Path> rootDirectory(InputContextParameters inputContext)

Description copied from class: FilesProvider

A root directory for these files, if it exists.

Any file that is part of the collection returned by this provider, must exist inside this directory (either directly or in any nested subdirectories).

Specified by:

rootDirectory in class FilesProvider

Parameters:

inputContext - the input-context.

Returns:

a path to this directory.