universum.studios.android.device.storage

Class StorageUtils

java.lang.Object

universum.studios.android.device.storage.StorageUtils

public final class StorageUtils
extends Object

Simple utility class specifying API allowing to create, copy, move or delete files on the current Android device's file system.

This class wraps instance of StorageEditor for all file content related operations, like deleting, copying and moving of file/directory content on the file system. Note, that all exceptions thrown by the editor need to be handled by a caller of the StorageUtils API itself.

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
static int	copyDirectories(int flags, FileFilter filter, FilenameFilter nameFilter, String toPath, String... fromPaths) Copies all directories at the given fromPaths on the file system.
static int	copyDirectories(int flags, String toPath, String... fromPaths) Same as copyDirectories(int, FileFilter, FilenameFilter, String, String...) with null filters.
static boolean	copyDirectory(int flags, FileFilter filter, FilenameFilter nameFilter, String toPath, String fromPath) Wrapped StorageEditor.copyDirectoryContent(int, File, File, FileFilter, FilenameFilter) upon this utils editor instance.
static boolean	copyDirectory(int flags, String toPath, String fromPath) Same as copyDirectory(int, FileFilter, FilenameFilter, String, String) with null filters.
static boolean	copyFile(int flags, String toPath, String fromPath) Wrapped StorageEditor.copyFileContent(int, File, File) upon this utils editor instance.
static int	copyFiles(int flags, String toPath, String... fromPaths) Copies all files at the given fromPaths on the file system.
static int	createDirectories(String... paths) Same as createDirectories(String, String...) with empty basePath.
static int	createDirectories(String basePath, String... paths) Creates all directories at the given paths on the file system.
static boolean	createDirectory(String path) Creates a new empty directory at the specified path on the file system.
static boolean	createFile(String path) Creates a new empty File at the specified path on the file system.
static int	createFiles(String... paths) Same as createFiles(String, String...) with empty basePath.
static int	createFiles(String basePath, String... paths) Creates all files at the given paths on the file system.
static int	deleteDirectories(FileFilter filter, FilenameFilter nameFilter, String basePath, String... paths) Deletes all directories at the given paths on the file system.
static int	deleteDirectories(String... paths) Same as deleteDirectories(String, String...) with empty basePath.
static int	deleteDirectories(String basePath, String... paths) Same as deleteDirectories(FileFilter, FilenameFilter, String, String...) with null filters.
static boolean	deleteDirectory(FileFilter filter, FilenameFilter nameFilter, String path) Wrapped StorageEditor.deleteDirectory(File, FileFilter, FilenameFilter) upon this utils editor instance.
static boolean	deleteDirectory(String path) Same as deleteDirectory(FileFilter, FilenameFilter, String) with null filters.
static boolean	deleteFile(String path) Deletes a file at the specified path on the file system.
static int	deleteFiles(String... paths) Same as deleteFiles(String, String...) with empty basePath.
static int	deleteFiles(String basePath, String... paths) Deletes all files at the given paths on the file system.
static boolean	directoryExists(String path) Checks whether a directory at the specified path on the file system exists or not.
static boolean	fileExists(String path) Checks whether a file at the specified path on the file system exists or not.
static boolean	isDirectoryEmpty(String path) Checks whether a directory at the specified path contains any files/subdirectories or not.
static int	moveDirectories(int flags, FileFilter filter, FilenameFilter nameFilter, String toPath, String... fromPaths) Moves all directories at the given fromPaths on the file system.
static int	moveDirectories(int flags, String toPath, String... fromPaths) Same as moveDirectories(int, FileFilter, FilenameFilter, String, String...) with null filters.
static boolean	moveDirectory(int flags, FileFilter filter, FilenameFilter nameFilter, String toPath, String fromPath) Wrapped StorageEditor.moveDirectoryContent(int, File, File, FileFilter, FilenameFilter) upon this utils editor instance.
static boolean	moveDirectory(int flags, String toPath, String fromPath) Same as moveDirectory(int, FileFilter, FilenameFilter, String, String) with null filters.
static boolean	moveFile(int flags, String toPath, String fromPath) Wrapped StorageEditor.moveFileContent(int, File, File) upon this utils editor instance.
static int	moveFiles(int flags, String toPath, String... fromPaths) Moves all files at the given fromPaths on the file system.

Methods inherited from class java.lang.Object

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

Method Detail

fileExists

public static boolean fileExists(String path)

Checks whether a file at the specified path on the file system exists or not.

Parameters:

path - Path of the desired file to check.

Returns:

True if the given path points to file which at this time exists, false if there is no file at the given path or it is a directory.

directoryExists

public static boolean directoryExists(String path)

Checks whether a directory at the specified path on the file system exists or not.

Parameters:

path - Path of the desired directory to check.

Returns:

True if the given path points to directory which at this time exists, false if there is no directory at the given path or it is a file.

isDirectoryEmpty

public static boolean isDirectoryEmpty(String path)

Checks whether a directory at the specified path contains any files/subdirectories or not.

Parameters:

path - Path of the desired directory to check.

Returns:

True if the given path points to directory which at this time exists and doesn't contains any files/subdirectories, false if it doesn't exists or if it is a file.

createFile

public static boolean createFile(String path)

Creates a new empty File at the specified path on the file system.

See File.createNewFile() for additional info.

Parameters:

path - Path of the desired file to be created.

Returns:

True if the requested file was successfully created or already exists, false if at the specified path already exists a directory with the same path or some IO error occurs.

createFiles

public static int createFiles(String... paths)

Same as createFiles(String, String...) with empty basePath.

createFiles

public static int createFiles(String basePath,
                              String... paths)

Creates all files at the given paths on the file system.

This is a bulk operation for createFile(String) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

basePath - A path to be used as base for the given paths, in case when they represents a relative paths.

paths - Paths of the desired files to be created.

Returns:

Count of the successfully created files.

createDirectory

public static boolean createDirectory(String path)

Creates a new empty directory at the specified path on the file system.

See File.mkdirs() for additional info.

Parameters:

path - Path of the desired directory to be created.

Returns:

True if the requested directory was successfully created or already exists, false if at the specified path already exists a file with the same path or some IO error occurs.

createDirectories

public static int createDirectories(String... paths)

Same as createDirectories(String, String...) with empty basePath.

createDirectories

public static int createDirectories(String basePath,
                                    String... paths)

Creates all directories at the given paths on the file system.

This is a bulk operation for createDirectory(String) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

basePath - A path to be used as base for the given paths, in case when they represents a relative paths.

paths - Paths of the desired directories to be created.

Returns:

Count of the successfully created directories.

deleteFile

public static boolean deleteFile(String path)

Deletes a file at the specified path on the file system.

Parameters:

path - Path to the desired file to be deleted.

Returns:

True if the requested file was successfully deleted, false if it is actually a directory or it doesn't exists.

deleteFiles

public static int deleteFiles(String... paths)

Same as deleteFiles(String, String...) with empty basePath.

deleteFiles

public static int deleteFiles(String basePath,
                              String... paths)

Deletes all files at the given paths on the file system.

This is a bulk operation for deleteFiles(String...) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

basePath - A path to be used as base for the given paths, in case when they represents a relative paths.

paths - Paths to the desired files to be deleted.

Returns:

Count of the successfully deleted files.

deleteDirectory

public static boolean deleteDirectory(String path)

Same as deleteDirectory(FileFilter, FilenameFilter, String) with null filters.

deleteDirectory

public static boolean deleteDirectory(FileFilter filter,
                                      FilenameFilter nameFilter,
                                      String path)

Wrapped StorageEditor.deleteDirectory(File, FileFilter, FilenameFilter) upon this utils editor instance.

Parameters:

path - The path to be used to create directory parameter for editor.

deleteDirectories

public static int deleteDirectories(String... paths)

Same as deleteDirectories(String, String...) with empty basePath.

deleteDirectories

public static int deleteDirectories(String basePath,
                                    String... paths)

Same as deleteDirectories(FileFilter, FilenameFilter, String, String...) with null filters.

deleteDirectories

public static int deleteDirectories(FileFilter filter,
                                    FilenameFilter nameFilter,
                                    String basePath,
                                    String... paths)

Deletes all directories at the given paths on the file system.

This is a bulk operation for deleteDirectory(FileFilter, FilenameFilter, String) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

basePath - A path to be used as base for the given paths, in case when they represents a relative paths.

paths - Paths to the desired directories to be deleted.

Returns:

Count of the successfully deleted directories.

copyFile

public static boolean copyFile(int flags,
                               String toPath,
                               String fromPath)
                        throws IOException

Wrapped StorageEditor.copyFileContent(int, File, File) upon this utils editor instance.

Note, that the given toPath will be appended with a last path segment obtained from the given fromPath.

Parameters:

toPath - The path to be used to create fromFile parameter for editor.

fromPath - The path to be used to create toFile parameter for editor.

Throws:

IOException

copyFiles

public static int copyFiles(int flags,
                            String toPath,
                            String... fromPaths)
                     throws IOException

Copies all files at the given fromPaths on the file system.

This is a bulk operation for copyFile(int, String, String) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

fromPaths - Paths to the desired files to be copied.

Returns:

Count of the successfully copied files.

Throws:

IOException

copyDirectory

public static boolean copyDirectory(int flags,
                                    String toPath,
                                    String fromPath)
                             throws IOException

Same as copyDirectory(int, FileFilter, FilenameFilter, String, String) with null filters.

Throws:

IOException

copyDirectory

public static boolean copyDirectory(int flags,
                                    FileFilter filter,
                                    FilenameFilter nameFilter,
                                    String toPath,
                                    String fromPath)
                             throws IOException

Wrapped StorageEditor.copyDirectoryContent(int, File, File, FileFilter, FilenameFilter) upon this utils editor instance.

Note, that the given toPath will be appended with a last path segment obtained from the given fromPath.

Parameters:

toPath - The path to be used to create fromDirectory parameter for editor.

fromPath - The path to be used to create toDirectory parameter for editor.

Throws:

IOException

copyDirectories

public static int copyDirectories(int flags,
                                  String toPath,
                                  String... fromPaths)
                           throws IOException

Same as copyDirectories(int, FileFilter, FilenameFilter, String, String...) with null filters.

Throws:

IOException

copyDirectories

public static int copyDirectories(int flags,
                                  FileFilter filter,
                                  FilenameFilter nameFilter,
                                  String toPath,
                                  String... fromPaths)
                           throws IOException

Copies all directories at the given fromPaths on the file system.

This is a bulk operation for copyDirectory(int, FileFilter, FilenameFilter, String, String) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

fromPaths - Paths to the desired directories to be copied.

Returns:

Count of the successfully copied directories.

Throws:

IOException

moveFile

public static boolean moveFile(int flags,
                               String toPath,
                               String fromPath)
                        throws IOException

Wrapped StorageEditor.moveFileContent(int, File, File) upon this utils editor instance.

Note, that the given toPath will be appended with a last path segment obtained from the given fromPath.

Parameters:

toPath - The path to be used to create fromFile parameter for editor.

fromPath - The path to be used to create toFile parameter for editor.

Throws:

IOException

moveFiles

public static int moveFiles(int flags,
                            String toPath,
                            String... fromPaths)
                     throws IOException

Moves all files at the given fromPaths on the file system.

This is a bulk operation for moveFile(int, String, String) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

fromPaths - Paths to the desired files to be moved.

Returns:

Count of the successfully moved files.

Throws:

IOException

moveDirectory

public static boolean moveDirectory(int flags,
                                    String toPath,
                                    String fromPath)
                             throws IOException

Same as moveDirectory(int, FileFilter, FilenameFilter, String, String) with null filters.

Throws:

IOException

moveDirectory

public static boolean moveDirectory(int flags,
                                    FileFilter filter,
                                    FilenameFilter nameFilter,
                                    String toPath,
                                    String fromPath)
                             throws IOException

Wrapped StorageEditor.moveDirectoryContent(int, File, File, FileFilter, FilenameFilter) upon this utils editor instance.

Note, that the given toPath will be appended with a last path segment obtained from the given fromPath.

Parameters:

toPath - The path to be used to create fromDirectory parameter for editor.

fromPath - The path to be used to create toDirectory parameter for editor.

Throws:

IOException

moveDirectories

public static int moveDirectories(int flags,
                                  String toPath,
                                  String... fromPaths)
                           throws IOException

Same as moveDirectories(int, FileFilter, FilenameFilter, String, String...) with null filters.

Throws:

IOException

moveDirectories

public static int moveDirectories(int flags,
                                  FileFilter filter,
                                  FilenameFilter nameFilter,
                                  String toPath,
                                  String... fromPaths)
                           throws IOException

Moves all directories at the given fromPaths on the file system.

This is a bulk operation for moveDirectory(int, FileFilter, FilenameFilter, String, String) method, so the given paths will be looped to perform the requested action for each of them.

Parameters:

fromPaths - Paths to the desired directories to be moved.

Returns:

Count of the successfully moved directories.

Throws:

IOException