mobi.designmyapp.common.util

Interface IOUtils

public interface IOUtils

This class provides IO utility methods

Method Summary

Modifier and Type	Method and Description
void	assertCanRead(String dir) Check whether the dir is readable
void	assertCanWrite(String dir) Check whether the dir is writeable
void	cleanDirectory(File directory) Cleans a directory without deleting it.
String	computePackage(String appName, String applicationPackage, String templateTag) Compute application full name with applicationPackage.templateTag.appName The appName is normalized
void	copyDirectoryContent(File sourceDir, File destDir) Copy all files in sourceDir to destDir.
void	copyFile(File srcFile, File destFile) Copy srcFile to destFile
void	copyFileToDirectory(File srcFile, File destDir) Copy srcFile to destDir
void	copyInputStreamToFile(InputStream inputStream, File file) Copies bytes from an inputStream to a file file.
void	createImageReference(String imageName, int drawableId, File tempDirectory) Create drawable reference in res/values/public.xml
void	deleteDirectory(File file) Deletes a directory recursively.
void	deleteFile(File file) Deletes a file.
void	eraseAndCopyDir(File sourceDir, File destDir) Cleans destDir without deleting it and copies sourceDir whole directory its location preserving the file dates
String	generateKey() Retrieve a pseudo randomly generated UUID.
String	getExtension(String name) Retrieve file extension from file name
String	getNameWithoutExtension(String name) Retrieve file name without extension from name
boolean	isMac() Check whether the current environment is mac based
boolean	isWindows() Check whether the current environment is windows based
File	locateFile(File sourceDir, String fileRelativePath) Locate for the file with fileRelativePath in directory sourceDir
long	minToMillis(long minutes) Convert Minutes to milliseconds
void	moveFile(File srcFile, File destFile) Moves a file.
InputStream	openClassPathResource(String path) Finds a resource with a given name.
String	parsePath(String pathToTest) Prevents path hacks such as ../my/path or /opt/my/path
String	readFileToString(File file) Reads the contents of a file into a String
String	removeExtension(String fileName) Removes the extension from a filename
void	replaceTokens(Map<String,String> model, File srcFile, File destFile) Perform token replacement in a file
void	replaceTokens(Object model, Boolean exceptionHandling, File srcDirectory, List<String> parseList, File destDirectory) Deprecated.

Method Detail

generateKey

String generateKey()

Retrieve a pseudo randomly generated UUID.

Returns:

A randomly generated UUID key

copyFile

void copyFile(File srcFile,
              File destFile)

Copy srcFile to destFile

Parameters:

srcFile - source File to be copied

destFile - destination file to be copied to

copyFileToDirectory

void copyFileToDirectory(File srcFile,
                         File destDir)

Copy srcFile to destDir

Parameters:

srcFile - source File to be copied

destDir - destination directory to be copied in

copyDirectoryContent

void copyDirectoryContent(File sourceDir,
                          File destDir)

Copy all files in sourceDir to destDir.

Parameters:

sourceDir - source directory to be copied

destDir - destination directory to be copied in

replaceTokens

@Deprecated
void replaceTokens(Object model,
                               Boolean exceptionHandling,
                               File srcDirectory,
                               List<String> parseList,
                               File destDirectory)

Deprecated.

Perform token replacement in multiple files

Parameters:

model - the model object. Any attribute name matching a token will have its value replace the token

exceptionHandling - exception handling behavior, true: errors are thrown if parsing fails, false: errors are ignored

srcDirectory - the source directory (read-only)

parseList - the relative paths from the source directory

destDirectory - the destination directory Warning: this method should not be used anymore, as it could create issues in the workflow in case non-custom files are modified Use replaceTokens(java.util.Map, java.io.File, java.io.File) instead

replaceTokens

void replaceTokens(Map<String,String> model,
                   File srcFile,
                   File destFile)

Perform token replacement in a file

Parameters:

model - the model object. The key being the token name, and value the String it will be replaced by

srcFile - the source file (read-only)

destFile - the destination file

locateFile

File locateFile(File sourceDir,
                String fileRelativePath)

Locate for the file with fileRelativePath in directory sourceDir

Parameters:

sourceDir - input source directory

fileRelativePath - relative path in source directory

Returns:

file if found

computePackage

String computePackage(String appName,
                      String applicationPackage,
                      String templateTag)

Compute application full name with applicationPackage.templateTag.appName The appName is normalized

Parameters:

appName - input application name

applicationPackage - input application package

templateTag - input template tag

Returns:

application full name

assertCanRead

void assertCanRead(String dir)

Check whether the dir is readable

Parameters:

dir - input dir

assertCanWrite

void assertCanWrite(String dir)

Check whether the dir is writeable

Parameters:

dir - input dir

getExtension

String getExtension(String name)

Retrieve file extension from file name

Parameters:

name - the name

Returns:

the extension only

getNameWithoutExtension

String getNameWithoutExtension(String name)

Retrieve file name without extension from name

Parameters:

name - the name

Returns:

the name only

removeExtension

String removeExtension(String fileName)

Removes the extension from a filename

Parameters:

fileName - the filename to query

Returns:

the filename minus the extension

cleanDirectory

void cleanDirectory(File directory)

Cleans a directory without deleting it.

Parameters:

directory - directory to clean

readFileToString

String readFileToString(File file)
                 throws IOException

Reads the contents of a file into a String

Parameters:

file - the file to read

Returns:

the file contents

Throws:

IOException - in case of an I/O error

copyInputStreamToFile

void copyInputStreamToFile(InputStream inputStream,
                           File file)

Copies bytes from an inputStream to a file file. The directories up to file will be created if they don't already exist. will be overwritten if it already exists.

Parameters:

inputStream - the InputStream to copy bytes from

file - the non-directory File to write bytes to

deleteDirectory

void deleteDirectory(File file)

Deletes a directory recursively.

Parameters:

file - directory to delete

deleteFile

void deleteFile(File file)

Deletes a file. If file is a directory, delete it and all sub-directories.

Parameters:

file - file or directory to delete, must not be null

moveFile

void moveFile(File srcFile,
              File destFile)

Moves a file. When the destination file is on another file system, do a "copy and delete".

Parameters:

srcFile - the file to be moved

destFile - the destination file

createImageReference

void createImageReference(String imageName,
                          int drawableId,
                          File tempDirectory)

Create drawable reference in res/values/public.xml

Parameters:

imageName - the name of the image

drawableId - the drawable resource id (android)

tempDirectory - the destination directory

minToMillis

long minToMillis(long minutes)

Convert Minutes to milliseconds

Parameters:

minutes - the number of minutes

Returns:

the millisecond representation of the provided minutes

parsePath

String parsePath(String pathToTest)

Prevents path hacks such as ../my/path or /opt/my/path

Parameters:

pathToTest - the initial path

Returns:

a string cleared of all eventual path hacks

eraseAndCopyDir

void eraseAndCopyDir(File sourceDir,
                     File destDir)

Cleans destDir without deleting it and copies sourceDir whole directory its location preserving the file dates

Parameters:

sourceDir - an existing directory to copy

destDir - the new directory

openClassPathResource

InputStream openClassPathResource(String path)

Finds a resource with a given name. The rules for searching resources associated with a given class are implemented by the defining ClassLoader of the class

Parameters:

path - name of the desired resource

Returns:

An InputStream object or null if no resource with this name is found

isWindows

boolean isWindows()

Check whether the current environment is windows based

Returns:

true on windows environment false otherwise

isMac

boolean isMac()

Check whether the current environment is mac based

Returns:

true on mac environment false otherwise