org.openimaj.tools

Class FileToolsUtil

java.lang.Object

org.openimaj.tools.FileToolsUtil

public class FileToolsUtil
extends Object

Tools for dealing with #InOutTool instances that are local file

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
FileToolsUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	isStdin(InOutToolOptions tool) Test whether the input is the stdin
static boolean	isStdout(InOutToolOptions tool) Test whether the requested output is stdout.
static List<File>	validateLocalInput(InOutToolOptions tool) Validate the (local) input from an InOutToolOptions and return the corresponding file.
static File	validateLocalOutput(InOutToolOptions tool) Validate the (local) ouput from an InOutToolOptions and return the corresponding file.
static File	validateLocalOutput(String out, boolean overwrite) Validate the (local) ouput from an String and return the corresponding file.
static File	validateLocalOutput(String out, boolean overwrite, boolean contin) Validate the (local) ouput from an String and return the corresponding file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileToolsUtil

public FileToolsUtil()

Method Detail

validateLocalInput

public static List<File> validateLocalInput(InOutToolOptions tool)
                                     throws IOException

Validate the (local) input from an InOutToolOptions and return the corresponding file.

Parameters:

tool - the tool from which to get settings

Returns:

a none null input file location if it exists

Throws:

IOException - if the file doesn't exist

isStdin

public static boolean isStdin(InOutToolOptions tool)

Test whether the input is the stdin

Parameters:

tool -

Returns:

true if input should be stdin, false otherwise.

isStdout

public static boolean isStdout(InOutToolOptions tool)

Test whether the requested output is stdout.

Parameters:

tool - the tool from which to get settings

Returns:

true if output the stdout; false otherwise.

validateLocalOutput

public static File validateLocalOutput(InOutToolOptions tool)
                                throws IOException

Validate the (local) ouput from an InOutToolOptions and return the corresponding file.

Parameters:

tool - the tool from which to get settings

Returns:

the output file location, deleted if it is allowed to be deleted

Throws:

IOException - if the file exists, but can't be deleted

validateLocalOutput

public static File validateLocalOutput(String out,
                                       boolean overwrite)
                                throws IOException

Validate the (local) ouput from an String and return the corresponding file.

Parameters:

out - where the file will go

overwrite - whether to overwrite existing files

Returns:

the output file location, deleted if it is allowed to be deleted

Throws:

IOException - if the file exists, but can't be deleted

validateLocalOutput

public static File validateLocalOutput(String out,
                                       boolean overwrite,
                                       boolean contin)
                                throws IOException

Validate the (local) ouput from an String and return the corresponding file.

Parameters:

out - where the file will go

overwrite - whether to overwrite existing files

contin - whether an existing output should be continued (i.e. ignored if it exists)

Returns:

the output file location, deleted if it is allowed to be deleted

Throws:

IOException - if the file exists, but can't be deleted