me.adaptive.arp.api

Interface IFile

All Superinterfaces:

IAdaptiveRP, IBaseData

All Known Implementing Classes:

FileBridge

public interface IFile
extends IBaseData

Interface for Managing the File operations

Since:

v2.0

Method Summary

Modifier and Type	Method and Description
boolean	canRead(FileDescriptor descriptor) Determine whether the current file/folder can be read from.
boolean	canWrite(FileDescriptor descriptor) Determine whether the current file/folder can be written to.
void	create(FileDescriptor descriptor, IFileResultCallback callback) Creates a file with the specified name.
boolean	delete(FileDescriptor descriptor, boolean cascade) Deletes the given file or path.
boolean	exists(FileDescriptor descriptor) Check whether the file/path exists.
void	getContent(FileDescriptor descriptor, IFileDataLoadResultCallback callback) Loads the content of the file.
IFileSystemStorageType	getFileStorageType(FileDescriptor descriptor) Returns the file storage type of the file
IFileSystemType	getFileType(FileDescriptor descriptor) Returns the file type
IFileSystemSecurity	getSecurityType(FileDescriptor descriptor) Returns the security type of the file
boolean	isDirectory(FileDescriptor descriptor) Check whether this is a path of a file.
void	listFiles(FileDescriptor descriptor, IFileListResultCallback callback) List all the files contained within this file/path reference.
void	listFilesForRegex(FileDescriptor descriptor, java.lang.String regex, IFileListResultCallback callback) List all the files matching the speficied regex filter within this file/path reference.
boolean	mkDir(FileDescriptor descriptor, boolean recursive) Creates the parent path (or paths, if recursive) to the given file/path if it doesn't already exist.
void	move(FileDescriptor source, FileDescriptor destination, boolean createPath, boolean overwrite, IFileResultCallback callback) Moves the current file to the given file destination, optionally overwriting and creating the path to the new destination file.
void	setContent(FileDescriptor descriptor, byte[] content, IFileDataStoreResultCallback callback) Sets the content of the file.

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

getAPIGroup, getAPIVersion

Method Detail

canRead

boolean canRead(FileDescriptor descriptor)

Determine whether the current file/folder can be read from.

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

True if the folder/file is readable, false otherwise.

Since:

v2.0

canWrite

boolean canWrite(FileDescriptor descriptor)

Determine whether the current file/folder can be written to.

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

True if the folder/file is writable, false otherwise.

Since:

v2.0

create

void create(FileDescriptor descriptor,
            IFileResultCallback callback)

Creates a file with the specified name.

Parameters:

descriptor - File descriptor of file or folder used for operation.

callback - Result of the operation.

Since:

v2.0

delete

boolean delete(FileDescriptor descriptor,
               boolean cascade)

Deletes the given file or path. If the file is a directory and contains files and or subdirectories, these will be deleted if the cascade parameter is set to true.

Parameters:

descriptor - File descriptor of file or folder used for operation.

cascade - Whether to delete sub-files and sub-folders.

Returns:

True if files (and sub-files and folders) whether deleted.

Since:

v2.0

exists

boolean exists(FileDescriptor descriptor)

Check whether the file/path exists.

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

True if the file exists in the filesystem, false otherwise.

Since:

v2.0

getContent

void getContent(FileDescriptor descriptor,
                IFileDataLoadResultCallback callback)

Loads the content of the file.

Parameters:

descriptor - File descriptor of file or folder used for operation.

callback - Result of the operation.

Since:

v2.0

getFileStorageType

IFileSystemStorageType getFileStorageType(FileDescriptor descriptor)

Returns the file storage type of the file

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

Storage Type file

Since:

v2.0

getFileType

IFileSystemType getFileType(FileDescriptor descriptor)

Returns the file type

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

Returns the file type of the file

Since:

v2.0

getSecurityType

IFileSystemSecurity getSecurityType(FileDescriptor descriptor)

Returns the security type of the file

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

Security Level of the file

Since:

v2.0

isDirectory

boolean isDirectory(FileDescriptor descriptor)

Check whether this is a path of a file.

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

true if this is a path to a folder/directory, false if this is a path to a file.

Since:

v2.0

listFilesForRegex

void listFilesForRegex(FileDescriptor descriptor,
                       java.lang.String regex,
                       IFileListResultCallback callback)

List all the files matching the speficied regex filter within this file/path reference. If the reference is a file, it will not yield any results.

Parameters:

descriptor - File descriptor of file or folder used for operation.

regex - Filter (eg. *.jpg, *.png, Fil*) name string.

callback - Result of operation.

Since:

v2.0

listFiles

void listFiles(FileDescriptor descriptor,
               IFileListResultCallback callback)

List all the files contained within this file/path reference. If the reference is a file, it will not yield any results.

Parameters:

descriptor - File descriptor of file or folder used for operation.

callback - Result of operation.

Since:

v2.0

mkDir

boolean mkDir(FileDescriptor descriptor,
              boolean recursive)

Creates the parent path (or paths, if recursive) to the given file/path if it doesn't already exist.

Parameters:

descriptor - File descriptor of file or folder used for operation.

recursive - Whether to create all parent path elements.

Returns:

True if the path was created, false otherwise (or it exists already).

Since:

v2.0

move

void move(FileDescriptor source,
          FileDescriptor destination,
          boolean createPath,
          boolean overwrite,
          IFileResultCallback callback)

Moves the current file to the given file destination, optionally overwriting and creating the path to the new destination file.

Parameters:

source - File descriptor of file or folder used for operation as source.

destination - File descriptor of file or folder used for operation as destination.

createPath - True to create the path if it does not already exist.

callback - Result of the operation.

overwrite - True to create the path if it does not already exist.

Since:

v2.0

setContent

void setContent(FileDescriptor descriptor,
                byte[] content,
                IFileDataStoreResultCallback callback)

Sets the content of the file.

Parameters:

descriptor - File descriptor of file or folder used for operation.

content - Binary content to store in the file.

callback - Result of the operation.

Since:

v2.0