de.dimensionv.android.androtools.filetools

Class FileTools

java.lang.Object

de.dimensionv.java.libraries.common.utilities.file.FileUtils

de.dimensionv.android.androtools.filetools.FileTools

public class FileTools
extends FileUtils

This class is a collection of useful routines regarding files, directories and URIs with specific extensions for the Android platform.

Each method is available statically, which means there is no need to instantiate FileTools. This is more memory efficient and allows for faster runtime then a class that has to be instantiated, first.

Please note that the Uri-objects used with methods introduced by this class are always Uri-objects, and not URI-objects. This is important, as there are also methods (inherited from FileUtils), which use URI-objects. These two classes are not interchangeable nor castable. They have nothing in common but Java's general base class Object, and that both handle URIs. Both have a completely different set of features and possibilities for use, and since this class is Android specific, it introduces the Android class Uri to enhance the feature-set inherited from FileUtils by this functionality.

Since:

API 1.0.0

Constructor Summary

Constructors

Constructor and Description
FileTools()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getApplicationCachePath(Context context) Retrieves the application's cache directory as String.
static String	getApplicationCachePath(Context context, boolean external) Retrieves the application's cache directory as String.
static File	getFile(Context context, Uri uri) Convert a Uri into a File.
static String	getPath(Context context, Uri uri) Get a file path from a Uri as String.
static Uri	getUri(File file) Convert a File into a Uri.
static boolean	hasThumbnailSupport(Uri uri) Returns true if the Uri has thumbnail-support through MediaStore.
static boolean	isMediaUri(Uri uri) Returns true if Uri is a media URI.

Methods inherited from class de.dimensionv.java.libraries.common.utilities.file.FileUtils

getExtension, getFile, getFile, getFile, getFileList, getPath, getPathWithoutFilename, getReadableFileSize, isLocal

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTools

public FileTools()

Method Detail

isMediaUri

public static boolean isMediaUri(Uri uri)

Returns true if Uri is a media URI.

A media URI is either an audio, video or image MediaStore content URI. Every other URI is not a media URI per definition of this method.

Please note that the Uri-object for this method is a Uri-object, and not a URI-object.

Parameters:

uri - The Uri-object to check

Returns:

true if Uri-object is a media URI, false otherwise.

Since:

Class 1.0, API 1.0.0

hasThumbnailSupport

public static boolean hasThumbnailSupport(Uri uri)

Returns true if the Uri has thumbnail-support through MediaStore.

Please note that the Uri-object for this method is a Uri-object, and not a URI-object.

Parameters:

uri - The Uri-object to check

Returns:

true if the file denoted by the Uri-object has thumbnail-support through Android's Media-framework.

Since:

Class 1.0, API 1.0.0

getUri

public static Uri getUri(File file)

Convert a File into a Uri.

Parameters:

file - The File-object to convert.

Returns:

the new Uri-object.

Since:

Class 1.0, API 1.0.0

getFile

public static File getFile(Context context,
           Uri uri)

Convert a Uri into a File.

Parameters:

uri - The Uri-object to convert.

Returns:

The new File-object.

Since:

Class 1.0, API 1.0.0

getPath

public static String getPath(Context context,
             Uri uri)

Get a file path from a Uri as String.

In case the Uri denotes a content-URI, the appropriate ContentProvider is queried to retrieve the path.

Parameters:

context - The Context-object in case the Uri is a content-URI.

uri - The Uri-object to extract the file-path from.

Returns:

The path of the file denoted by the Uri-object.

Throws:

InvalidValueException - Thrown if the Uri object does not contain a valid file-path or the ContentProvider query fails.

Since:

Class 1.0, API 1.0.0

getApplicationCachePath

public static String getApplicationCachePath(Context context,
                             boolean external)

Retrieves the application's cache directory as String.

Upon the first call, this method queries for both cache-directories, the one on the internal storage and a possible one on an possible external storage. Both (if there is an external one) are then cached in a static variable which is simply returned on subsequent calls. If the external storage is not available for whatever reasons, but becomes available at a later time, the external storage will not be queried again and will remain inaccessible.

The directory returned is determined by the second parameter.

Parameters:

context - The Context-object used to identify and retrieve the cache-directory.

external - Whether to return the directory on the external or internal storage.

Returns:

The path to the cache-directory. Can be null if external is true and the external storage is not available.

Since:

Class 1.0, API 1.0.0

getApplicationCachePath

public static String getApplicationCachePath(Context context)

Retrieves the application's cache directory as String.

This method is a convenience method to retrieve any cache-directory, with preference to the external storage, if available and mounted. If the external storage is not available, the internal storage will be used. The external storage will not be queried again for availability, in that case.

Parameters:

context - The Context-object used to identify and retrieve the cache-directory.

Returns:

The path to the cache-directory. Will not be null, because if there is no external storage, the internal storage will be returned.

Since:

Class 1.0, API 1.0.0