AndroidExternalFileWriter

A helper class to write files in external android storage, along with it's demo application.

Class is separately located at https://gist.github.com/PrashamTrivedi/6121924

Maven Availibility

This repository is also available with maven, in [artyfactory ] (https://github.com/PrashamTrivedi/ArtyFactory)repository.

To add it in gradle file add this in your repositories.

  maven {
            url 'https://github.com/PrashamTrivedi/ArtyFactory/raw/master/snapshots'
            //THIS IS TO GET SNAPSHOTS TO GET RELEASES (IN FUTURE) ADD/REPLACE IT WITH
            //url 'https://github.com/PrashamTrivedi/ArtyFactory/raw/master/releases'
  }

The maven credentials (groupId:artifactId:verison) are

com.phtrivedi.opensource:AppExternalLibrary:1.0.1-SNAPSHOT

How does it work

Create AppExternalFileWriter object with passing context to it.
Use writeDataToFile or writeDataToTimeStampedFile variants as per your wish.
If you want to write a data where a file name should be a time stamp use writeDataToTimeStampedFile variants.
If you want to create a subdirectory use suitable createSubDirectory variants.
If anything is wrong with external storage, like storage not mounted, corrupt, shared as mass storage, not enough space available, or even trying to create a library already created. The class will throw ExternalFileWriterException with the message stating what happened.
If you want to write a data in external cache memory do following.
- Check the variants of all the methods where it asks for a boolean variable, if you pass true the file operation is done in external cache , otherwise it will be done in normal external memory.
- If have already created a directory in cache memory get it from createDirectory method, and pass this directory to any method where a parent is required. These methods work same regardless of parent is in external memory or in cache memory.
Checks whether certain directory or file exists on certain location or not with help of isFileExists or isDirectoryExists variants
Deletes entire directory with deleteDirectory method (Note : This method only cares about removing entire directory with its subcontents, if you want to check whether directory is empty or not and use some error message, I recommend to use File.delete() method.)

Description of Variants

writeDataToFile - Without parent directories

writeDataToFile(String fileName, byte[] data,boolean inCache);
writeDataToFile(String fileName, String data,boolean inCache);

Writes data to desired file in Application directory.

writeDataToFile - With parent directories

writeDataToFile(File parent, String fileName, byte[] data);
writeDataToFile(File parent, String fileName, String data);

Writes data to desired file in other directory.

writeDataToTimeStampedFile variants - Without parent directories

writeDataToTimeStampedFile(String extension, byte[] data,boolean inCache)
writeDataToTimeStampedFile(String extension, String data,boolean inCache)

Writes data to desired file with timestamp with extension in Application directory.

writeDataToTimeStampedFile variants - With parent directories

writeDataToTimeStampedFile(String extension, byte[] data)
writeDataToTimeStampedFile(String extension, String data)

Writes data to desired file with timestamp with extension in other directory.

createSubDirectory variants

createSubDirectory(File parent, String directoryName)

Creates subdirectory in any other directory

createSubDirectory(String directoryName,boolean inCache)

Creates subdirectory in application directory.

isDirectoryExists variants

isDirectoryExists(String directoryName, boolean checkInCache)

Checks whether directory with given name exists in AppDirectory Or Cache directory

isDirectoryExists(String directoryName, File parentDirectory)

Checks whether directory with given name exists in parentDirectory or not.

isFileExists variants

isFileExists(String fileName, boolean checkInCache)

Checks whether file with given name exists in AppDirectory

isFileExists(String fileName, File parentDirectory)

Check whether directory with given name exists in parentDirectory or not.

Delete Directory

deleteDirectory(File directory)

Deletes given directory with all its subdirectories and its files.

Some goodies

getAppDirectory() : File object of created app directory
getExternalStorageDirectory() : File object of external storage directory
getExternalCacheDirectory() : File object of external cache directory

Note for Eclipse users