me.adaptive.arp.api

Interface IFileSystem

All Superinterfaces:

IAdaptiveRP, IBaseData

All Known Implementing Classes:

FileSystemBridge

public interface IFileSystem
extends IBaseData

Interface for Managing the File System operations

Since:

v2.0

Method Summary

Modifier and Type	Method and Description
FileDescriptor	createFileDescriptor(FileDescriptor parent, java.lang.String name) Creates a new reference to a new or existing location in the filesystem.
FileDescriptor	getApplicationCacheFolder() Returns a reference to the cache folder for the current application.
FileDescriptor	getApplicationCloudFolder() Returns a reference to the cloud synchronizable folder for the current application.
FileDescriptor	getApplicationDocumentsFolder() Returns a reference to the documents folder for the current application.
FileDescriptor	getApplicationFolder() Returns a reference to the application installation folder.
FileDescriptor	getApplicationProtectedFolder() Returns a reference to the protected storage folder for the current application.
char	getSeparator() Returns the file system dependent file separator.
FileDescriptor	getSystemExternalFolder() Returns a reference to the external storage folder provided by the OS.

Methods inherited from interface me.adaptive.arp.api.IAdaptiveRP

getAPIGroup, getAPIVersion

Method Detail

createFileDescriptor

FileDescriptor createFileDescriptor(FileDescriptor parent,
                                    java.lang.String name)

Creates a new reference to a new or existing location in the filesystem. This method does not create the actual file in the specified folder.

Parameters:

parent - Parent directory.

name - Name of new file or directory.

Returns:

A reference to a new or existing location in the filesystem.

Since:

v2.0

getApplicationCacheFolder

FileDescriptor getApplicationCacheFolder()

Returns a reference to the cache folder for the current application. This path must always be writable by the current application. This path is volatile and may be cleaned by the OS periodically.

Returns:

Path to the application's cache folder.

Since:

v2.0

getApplicationCloudFolder

FileDescriptor getApplicationCloudFolder()

Returns a reference to the cloud synchronizable folder for the current application. This path must always be writable by the current application.

Returns:

Path to the application's cloud storage folder.

Since:

v2.0

getApplicationDocumentsFolder

FileDescriptor getApplicationDocumentsFolder()

Returns a reference to the documents folder for the current application. This path must always be writable by the current application.

Returns:

Path to the application's documents folder.

Since:

v2.0

getApplicationFolder

FileDescriptor getApplicationFolder()

Returns a reference to the application installation folder. This path may or may not be directly readable or writable - it usually contains the app binary and data.

Returns:

Path to the application folder.

Since:

v2.0

getApplicationProtectedFolder

FileDescriptor getApplicationProtectedFolder()

Returns a reference to the protected storage folder for the current application. This path must always be writable by the current application.

Returns:

Path to the application's protected storage folder.

Since:

v2.0

getSeparator

char getSeparator()

Returns the file system dependent file separator.

Returns:

char with the directory/file separator.

Since:

v2.0

getSystemExternalFolder

FileDescriptor getSystemExternalFolder()

Returns a reference to the external storage folder provided by the OS. This may be an external SSD card or similar. This type of storage is removable and by definition, not secure. This path may or may not be writable by the current application.

Returns:

Path to the application's documents folder.

Since:

v2.0