public abstract class FileNamer extends AnchorBean<FileNamer>
The operation can be processed on a single file or a collection of files.
Constructor and Description |
---|
FileNamer() |
Modifier and Type | Method and Description |
---|---|
NamedFile |
deriveName(File file,
FileNamerContext context)
A name for a file.
|
abstract List<NamedFile> |
deriveName(List<File> files,
FileNamerContext context)
Derives a list of names (associated with each file) for some files.
|
List<NamedFile> |
deriveNameUnique(List<File> files,
FileNamerContext context)
Like
deriveName(List, FileNamerContext) but checks that the final list of
named-files all have unique names. |
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public NamedFile deriveName(File file, FileNamerContext context)
file
- the file to extract a name for.context
- additional context for naming.public abstract List<NamedFile> deriveName(List<File> files, FileNamerContext context)
files
- the files to describe.context
- additional context for naming.public List<NamedFile> deriveNameUnique(List<File> files, FileNamerContext context) throws InputReadFailedException
deriveName(List, FileNamerContext)
but checks that the final list of
named-files all have unique names.files
- the files to describe.context
- additional context for naming.InputReadFailedException
- if more than one NamedFile
have the same nameCopyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.