me.adaptive.arp.impl

Class FileSystemDelegate

java.lang.Object

me.adaptive.arp.impl.BaseDataDelegate

me.adaptive.arp.impl.FileSystemDelegate

All Implemented Interfaces:

me.adaptive.arp.api.IAdaptiveRP, me.adaptive.arp.api.IBaseData, me.adaptive.arp.api.IFileSystem

public class FileSystemDelegate
extends BaseDataDelegate
implements me.adaptive.arp.api.IFileSystem

Interface for Managing the File System operations Auto-generated implementation of IFileSystem specification.

Constructor Summary

Constructors

Constructor and Description
FileSystemDelegate() Default Constructor.

Method Summary

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

Methods inherited from class me.adaptive.arp.impl.BaseDataDelegate

getAPIGroup, getAPIVersion

Methods inherited from class java.lang.Object

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

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

getAPIGroup, getAPIVersion

Constructor Detail

FileSystemDelegate

public FileSystemDelegate()

Default Constructor.

Method Detail

createFileDescriptor

public me.adaptive.arp.api.FileDescriptor createFileDescriptor(me.adaptive.arp.api.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.

Specified by:

createFileDescriptor in interface me.adaptive.arp.api.IFileSystem

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

public me.adaptive.arp.api.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.

Specified by:

getApplicationCacheFolder in interface me.adaptive.arp.api.IFileSystem

Returns:

Path to the application's cache folder.

Since:

v2.0

getApplicationCloudFolder

public me.adaptive.arp.api.FileDescriptor getApplicationCloudFolder()

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

Specified by:

getApplicationCloudFolder in interface me.adaptive.arp.api.IFileSystem

Returns:

Path to the application's cloud storage folder.

Since:

v2.0

getApplicationDocumentsFolder

public me.adaptive.arp.api.FileDescriptor getApplicationDocumentsFolder()

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

Specified by:

getApplicationDocumentsFolder in interface me.adaptive.arp.api.IFileSystem

Returns:

Path to the application's documents folder.

Since:

v2.0

getApplicationFolder

public me.adaptive.arp.api.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.

Specified by:

getApplicationFolder in interface me.adaptive.arp.api.IFileSystem

Returns:

Path to the application folder.

Since:

v2.0

getApplicationProtectedFolder

public me.adaptive.arp.api.FileDescriptor getApplicationProtectedFolder()

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

Specified by:

getApplicationProtectedFolder in interface me.adaptive.arp.api.IFileSystem

Returns:

Path to the application's protected storage folder.

Since:

v2.0

getSeparator

public char getSeparator()

Returns the file system dependent file separator.

Specified by:

getSeparator in interface me.adaptive.arp.api.IFileSystem

Returns:

char with the directory/file separator.

Since:

v2.0

getSystemExternalFolder

public me.adaptive.arp.api.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.

Specified by:

getSystemExternalFolder in interface me.adaptive.arp.api.IFileSystem

Returns:

Path to the application's documents folder.

Since:

v2.0