public abstract class FilesProvider extends AnchorBean<FilesProvider>
File
s.Constructor and Description |
---|
FilesProvider() |
Modifier and Type | Method and Description |
---|---|
abstract List<File> |
create(InputManagerParameters parameters)
Creates or provides a list of files.
|
abstract Optional<Path> |
rootDirectory(InputContextParameters inputContext)
A root directory for these files, if it exists.
|
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public abstract List<File> create(InputManagerParameters parameters) throws FilesProviderException
parameters
- parameters influencing how input-files are obtained.FilesProviderException
- if list of files cannot be successfully established.public abstract Optional<Path> rootDirectory(InputContextParameters inputContext) throws FilesProviderException
Any file that is part of the collection returned by this provider, must exist inside this directory (either directly or in any nested subdirectories).
inputContext
- the input-context.FilesProviderException
- if an error occurs establishing the root directory.Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.