Package qupath.lib.gui

Class FileCopier

java.lang.Object

qupath.lib.gui.FileCopier

public class FileCopier
extends Object

Copy files to an output directory, prompting the user if necessary.

This is intended for interactive use; if there is an exception, the user will be notified by an error message dialog.

Since:

v0.5.0

Author:

Pete Bankhead

Constructor Summary

Constructors

Constructor	Description
FileCopier()

Method Summary

Modifier and Type	Method	Description
void	doCopy()	Perform the copying.
FileCopier	inputFiles(Collection<File> files)	Collection of files to copy.
FileCopier	inputPaths(Collection<Path> paths)	Collection of paths representing files to copy.
FileCopier	outputPath(String name)	Name of the output directory.
FileCopier	outputPath(Path name)	Path representing the output directory.
FileCopier	relativeToUserDirectory()	Specify that the copying is relative to the QuPath user directory.
FileCopier	title(String title)	Title for any dialog.

Methods inherited from class java.lang.Object

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

Constructor Details

FileCopier

public FileCopier()

Method Details

title

public FileCopier title(String title)

Title for any dialog.

Parameters:

title -

Returns:

relativeToUserDirectory

public FileCopier relativeToUserDirectory()

Specify that the copying is relative to the QuPath user directory. This is useful if copying files to the user directory itself, or a subdirectory. If this method is called, then the user will be prompted to create a user directory if one does not already exist.

Returns:

outputPath

public FileCopier outputPath(String name)

Name of the output directory. If relativeToUserDirectory() is selected, this should be given relative to the QuPath user directory; otherwise, it should be an absolute path.

Parameters:

name -

Returns:

See Also:

• outputPath(Path)

outputPath

public FileCopier outputPath(Path name)

Path representing the output directory. If relativeToUserDirectory() is selected, this should be given relative to the QuPath user directory; otherwise, it should be an absolute path.

Parameters:

name -

Returns:

See Also:

• outputPath(String)

inputFiles

public FileCopier inputFiles(Collection<File> files)

Collection of files to copy.

Parameters:

files -

Returns:

See Also:

• inputPaths(Collection)

inputPaths

public FileCopier inputPaths(Collection<Path> paths)

Collection of paths representing files to copy.

Parameters:

paths -

Returns:

See Also:

• inputFiles(Collection)

doCopy

public void doCopy()

Perform the copying. Note that any exceptions will be caught and displayed to the user in an error dialog.