Module io.annot8.components.files

Package io.annot8.components.files.processors

Class MoveSourceFile.Settings

java.lang.Object

io.annot8.components.files.processors.MoveSourceFile.Settings

All Implemented Interfaces:

io.annot8.api.settings.Settings

Enclosing class:

MoveSourceFile

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

Constructor Summary

Constructors

Constructor	Description
Settings()

Method Summary

Modifier and Type	Method	Description
List<Path>	getBasePaths()
Path	getRootOutputFolder()
boolean	isCopyOriginalFile()
boolean	isFlatten()
boolean	isReplaceExisting()
boolean	isUpdateSource()
void	setBasePaths(List<Path> basePaths)
void	setCopyOriginalFile(boolean copyOriginalFile)
void	setFlatten(boolean flatten)
void	setReplaceExisting(boolean replaceExisting)
void	setRootOutputFolder(Path rootOutputFolder)
void	setUpdateSource(boolean updateSource)
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()

Method Detail

validate

public boolean validate()

Specified by:

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

getRootOutputFolder

@Description(value="The root folder in which to save files",
             defaultValue=".")
public Path getRootOutputFolder()

setRootOutputFolder

public void setRootOutputFolder(Path rootOutputFolder)

getBasePaths

@Description("If the source path of any Item begins with any of these paths, then it will be truncated")
public List<Path> getBasePaths()

setBasePaths

public void setBasePaths(List<Path> basePaths)

isCopyOriginalFile

@Description(value="If true, then the source file is copied instead of moved",
             defaultValue="false")
public boolean isCopyOriginalFile()

setCopyOriginalFile

public void setCopyOriginalFile(boolean copyOriginalFile)

isReplaceExisting

@Description(value="If true, then any existing files will be replaced. If false, then an error will be thrown if the target file already exists.",
             defaultValue="false")
public boolean isReplaceExisting()

setReplaceExisting

public void setReplaceExisting(boolean replaceExisting)

isFlatten

@Description(value="If true, then all files are moved into the same top level folder and the base path is ignored",
             defaultValue="false")
public boolean isFlatten()

setFlatten

public void setFlatten(boolean flatten)

isUpdateSource

@Description(value="If true, then the source property of the Item is updated following a successful move",
             defaultValue="false")
public boolean isUpdateSource()

setUpdateSource

public void setUpdateSource(boolean updateSource)