boofcv.io

Class UtilIO

java.lang.Object

boofcv.io.UtilIO

public class UtilIO
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
UtilIO()

Method Summary

Modifier and Type	Method and Description
static void	deleteRecursive(java.io.File f) Deletes all the file/directory and all of its children
static java.io.File[]	findMatches(java.io.File directory, java.lang.String regex) Looks for file names which match the regex in the directory.
static java.io.File	getFileToBase()
static java.lang.String	getGithubURL(java.lang.String pkg, java.lang.String app)
static java.lang.String	getPathToBase() Steps back until it finds the base BoofCV directory.
static java.lang.String	getSourcePath(java.lang.String pkg, java.lang.String app) Constructs the path for a source code file residing in the examples or demonstrations directory In the case of the file not being in either directory, an empty string is returned The expected parameters are class.getPackage().getName(), class.getSimpleName()
static int	indexOfSourceStart(java.lang.String code) Finds the first javadoc OR the start of the class, which ever comes first.
static java.util.List<java.lang.String>	listAll(java.lang.String directory)
static java.util.List<java.lang.String>	listByPrefix(java.lang.String directory, java.lang.String prefix) Loads a list of files with the specified prefix.
static <T> T	load(java.lang.String fileName)
static boolean	loadLibrary(java.lang.String libraryName)
static void	loadLibrarySmart(java.lang.String libraryName)
static java.lang.String	path(java.lang.String path) Searches for the root BoofCV directory and returns an absolute path from it.
static java.lang.String	pathExample(java.lang.String path) Returns an absolute path to the file that is relative to the example directory
static java.lang.String	readAsString(java.io.InputStream stream) Reads an entire file and converts it into a text string
static java.lang.String	readAsString(java.lang.String path) Reads an entire file and converts it into a text string
static void	save(java.lang.Object o, java.lang.String fileName)
static java.lang.String	selectFile(boolean exitOnCancel) Opens up a dialog box asking the user to select a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtilIO

public UtilIO()

Method Detail

pathExample

public static java.lang.String pathExample(java.lang.String path)

Returns an absolute path to the file that is relative to the example directory

Parameters:

path - File path relative to root directory

Returns:

Absolute path to file

path

public static java.lang.String path(java.lang.String path)

Searches for the root BoofCV directory and returns an absolute path from it.

Parameters:

path - File path relative to root directory

Returns:

Absolute path to file

getFileToBase

public static java.io.File getFileToBase()

getPathToBase

public static java.lang.String getPathToBase()

Steps back until it finds the base BoofCV directory.

Returns:

Path to the base directory.

selectFile

public static java.lang.String selectFile(boolean exitOnCancel)

Opens up a dialog box asking the user to select a file. If the user cancels it either returns null or quits the program.

Parameters:

exitOnCancel - If it should quit on cancel or not.

Returns:

Name of the selected file or null if nothing was selected.

loadLibrarySmart

public static void loadLibrarySmart(java.lang.String libraryName)

loadLibrary

public static boolean loadLibrary(java.lang.String libraryName)

save

public static void save(java.lang.Object o,
                        java.lang.String fileName)

load

public static <T> T load(java.lang.String fileName)

deleteRecursive

public static void deleteRecursive(java.io.File f)

Deletes all the file/directory and all of its children

readAsString

public static java.lang.String readAsString(java.lang.String path)

Reads an entire file and converts it into a text string

readAsString

public static java.lang.String readAsString(java.io.InputStream stream)

Reads an entire file and converts it into a text string

getSourcePath

public static java.lang.String getSourcePath(java.lang.String pkg,
                                             java.lang.String app)

Constructs the path for a source code file residing in the examples or demonstrations directory In the case of the file not being in either directory, an empty string is returned The expected parameters are class.getPackage().getName(), class.getSimpleName()

Parameters:

pkg - package containing the class

app - simple class name

Returns:

getGithubURL

public static java.lang.String getGithubURL(java.lang.String pkg,
                                            java.lang.String app)

indexOfSourceStart

public static int indexOfSourceStart(java.lang.String code)

Finds the first javadoc OR the start of the class, which ever comes first. This does require some thought. The word class can easily be inside a comment. Comments may or may not be there. Always the potential for stray //

listByPrefix

public static java.util.List<java.lang.String> listByPrefix(java.lang.String directory,
                                                            java.lang.String prefix)

Loads a list of files with the specified prefix.

Parameters:

directory - Directory it looks inside of

prefix - Prefix that the file must have

Returns:

List of files that are in the directory and match the prefix.

listAll

public static java.util.List<java.lang.String> listAll(java.lang.String directory)

findMatches

public static java.io.File[] findMatches(java.io.File directory,
                                         java.lang.String regex)

Looks for file names which match the regex in the directory.

Example:
BoofMiscOps.findMatches(new File("/path/to/directory"), ".+jpg");

Parameters:

directory - directory

regex - file name regex

Returns:

array of matching files