me.adaptive.arp.impl

Class FileDelegate

java.lang.Object

me.adaptive.arp.impl.BaseDataDelegate

me.adaptive.arp.impl.FileDelegate

All Implemented Interfaces:

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

public class FileDelegate
extends BaseDataDelegate
implements me.adaptive.arp.api.IFile

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

Constructor Summary

Constructors

Constructor and Description
FileDelegate() Default Constructor.

Method Summary

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

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

FileDelegate

public FileDelegate()

Default Constructor.

Method Detail

canRead

public boolean canRead(me.adaptive.arp.api.FileDescriptor descriptor)

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

Specified by:

canRead in interface me.adaptive.arp.api.IFile

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

public boolean canWrite(me.adaptive.arp.api.FileDescriptor descriptor)

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

Specified by:

canWrite in interface me.adaptive.arp.api.IFile

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

public void create(me.adaptive.arp.api.FileDescriptor descriptor,
                   me.adaptive.arp.api.IFileResultCallback callback)

Creates a file with the specified name.

Specified by:

create in interface me.adaptive.arp.api.IFile

Parameters:

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

callback - Result of the operation.

Since:

v2.0

delete

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

Specified by:

delete in interface me.adaptive.arp.api.IFile

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

public boolean exists(me.adaptive.arp.api.FileDescriptor descriptor)

Check whether the file/path exists.

Specified by:

exists in interface me.adaptive.arp.api.IFile

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

public void getContent(me.adaptive.arp.api.FileDescriptor descriptor,
                       me.adaptive.arp.api.IFileDataLoadResultCallback callback)

Loads the content of the file.

Specified by:

getContent in interface me.adaptive.arp.api.IFile

Parameters:

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

callback - Result of the operation.

Since:

v2.0

getFileStorageType

public me.adaptive.arp.api.IFileSystemStorageType getFileStorageType(me.adaptive.arp.api.FileDescriptor descriptor)

Returns the file storage type of the file

Specified by:

getFileStorageType in interface me.adaptive.arp.api.IFile

Parameters:

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

Returns:

Storage Type file

Since:

v2.0

getFileType

public me.adaptive.arp.api.IFileSystemType getFileType(me.adaptive.arp.api.FileDescriptor descriptor)

Returns the file type

Specified by:

getFileType in interface me.adaptive.arp.api.IFile

Parameters:

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

Returns:

Returns the file type of the file

Since:

v2.0

getSecurityType

public me.adaptive.arp.api.IFileSystemSecurity getSecurityType(me.adaptive.arp.api.FileDescriptor descriptor)

Returns the security type of the file

Specified by:

getSecurityType in interface me.adaptive.arp.api.IFile

Parameters:

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

Returns:

Security Level of the file

Since:

v2.0

isDirectory

public boolean isDirectory(me.adaptive.arp.api.FileDescriptor descriptor)

Check whether this is a path of a file.

Specified by:

isDirectory in interface me.adaptive.arp.api.IFile

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

listFiles

public void listFiles(me.adaptive.arp.api.FileDescriptor descriptor,
                      me.adaptive.arp.api.IFileListResultCallback callback)

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

Specified by:

listFiles in interface me.adaptive.arp.api.IFile

Parameters:

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

callback - Result of operation.

Since:

v2.0

listFilesForRegex

public void listFilesForRegex(me.adaptive.arp.api.FileDescriptor descriptor,
                              java.lang.String regex,
                              me.adaptive.arp.api.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.

Specified by:

listFilesForRegex in interface me.adaptive.arp.api.IFile

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

mkDir

public boolean mkDir(me.adaptive.arp.api.FileDescriptor descriptor,
                     boolean recursive)

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

Specified by:

mkDir in interface me.adaptive.arp.api.IFile

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

public void move(me.adaptive.arp.api.FileDescriptor source,
                 me.adaptive.arp.api.FileDescriptor destination,
                 boolean createPath,
                 boolean overwrite,
                 me.adaptive.arp.api.IFileResultCallback callback)

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

Specified by:

move in interface me.adaptive.arp.api.IFile

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

public void setContent(me.adaptive.arp.api.FileDescriptor descriptor,
                       byte[] content,
                       me.adaptive.arp.api.IFileDataStoreResultCallback callback)

Sets the content of the file.

Specified by:

setContent in interface me.adaptive.arp.api.IFile

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