Module io.annot8.components.files

Package io.annot8.components.files.sources

Class FileSystemSource.Settings

java.lang.Object

io.annot8.components.files.sources.FileSystemSource.Settings

All Implemented Interfaces:

io.annot8.api.settings.Settings

Enclosing class:

FileSystemSource

public static class FileSystemSource.Settings
extends Object
implements io.annot8.api.settings.Settings

Constructor Summary

Constructors

Constructor	Description
Settings()
Settings(Path rootFolder)

Method Summary

Modifier and Type	Method	Description
Set<Pattern>	getAcceptedFileNamePatterns()
long	getDelay()
Path	getRootFolder()
boolean	isNegateAcceptedFileNamePatterns()
boolean	isRecursive()
boolean	isReprocessOnModify()
boolean	isWatching()
void	setAcceptedFileNamePatterns(Set<Pattern> acceptedFileNamePatterns)
void	setDelay(long delay)
void	setNegateAcceptedFileNamePatterns(boolean negateAcceptedFileNamePatterns)
void	setRecursive(boolean recursive)
void	setReprocessOnModify(boolean reprocessOnModify)
void	setRootFolder(Path rootFolder)
void	setWatching(boolean watching)
boolean	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Settings

public Settings()

Settings

public Settings(Path rootFolder)

Method Detail

getRootFolder

@Description(value="Root folder to read from",
             defaultValue=".")
public Path getRootFolder()

setRootFolder

public void setRootFolder(Path rootFolder)

isRecursive

@Description(value="Should the folder be read recursively",
             defaultValue="true")
public boolean isRecursive()

setRecursive

public void setRecursive(boolean recursive)

isReprocessOnModify

@Description(value="Should files be reprocessed if they are modified",
             defaultValue="true")
public boolean isReprocessOnModify()

setReprocessOnModify

public void setReprocessOnModify(boolean reprocessOnModify)

getAcceptedFileNamePatterns

@Description("Accepted file name patterns")
public Set<Pattern> getAcceptedFileNamePatterns()

setAcceptedFileNamePatterns

public void setAcceptedFileNamePatterns(Set<Pattern> acceptedFileNamePatterns)

isNegateAcceptedFileNamePatterns

@Description(value="If true, then the list of accepted file name patterns is treated as a reject list rather than an accept list",
             defaultValue="false")
public boolean isNegateAcceptedFileNamePatterns()

setNegateAcceptedFileNamePatterns

public void setNegateAcceptedFileNamePatterns(boolean negateAcceptedFileNamePatterns)

isWatching

@Description(value="Should the folder be watched for changes (true), or just scanned once (false)",
             defaultValue="true")
public boolean isWatching()

setWatching

public void setWatching(boolean watching)

getDelay

@Description(value="The length of delay to introduce between the file being detected and the file being processed - can be used to avoid partially copied files being picked up",
             defaultValue="0")
public long getDelay()

setDelay

public void setDelay(long delay)

validate

public boolean validate()

Specified by:

validate in interface io.annot8.api.settings.Settings