eve.net.rapi

Class RapiFile

java.lang.Object

eve.io.File

eve.io.FileAdapter

eve.net.rapi.RapiFile

All Implemented Interfaces:

FileConstants, FilePermissions, VolumeConstants, Textable

public class RapiFile
extends FileAdapter

Field Summary

Fields inherited from class eve.io.File

name

Fields inherited from interface eve.io.FileConstants

ClosedFolderIcon, DOS_SYSTEM, DriveIcon, FileIcon, FLAG_CASE_SENSITIVE, FLAG_FILE_SYSTEM_IS_READ_ONLY, FLAG_IS_NETWORK_COMPUTER, FLAG_IS_NETWORK_ROOT, FLAG_IS_ON_NETWORK, FLAG_READ_ONLY, FLAG_SLOW_ACCESS, FLAG_SLOW_CHILD_COUNT, FLAG_SLOW_LIST, INFO_CREATE_TEMP, INFO_CURRENT_DIRECTORY, INFO_DETAIL_NAMES, INFO_DETAIL_WIDTHS, INFO_DETAILS, INFO_DEVICE_ICON, INFO_DEVICE_NAME, INFO_FILE_TIMES, INFO_FLAGS, INFO_FREE_DRIVE_SPACE, INFO_GROUP, INFO_ICON, INFO_LINK_DESTINATION, INFO_OPTION_ICON_LARGE, INFO_OPTION_ICON_MEDIUM, INFO_OPTION_ICON_SMALL, INFO_OWNER, INFO_PROGRAM_DIRECTORY, INFO_ROOT_LIST, INFO_SET_USER_AND_GROUP, INFO_SYMBOLIC_LINK_TARGET, INFO_SYSTEM_TYPE, INFO_TEMPORARY_DIRECTORY, INFO_TOOL_TIP, INFO_TOTAL_DRIVE_SPACE, INFO_VOLUME_FLAGS, INFO_VOLUME_LIST, INFO_VOLUME_PROPERTIES, LIST_ALWAYS_INCLUDE_DIRECTORIES, LIST_BY_DATE, LIST_BY_NAME, LIST_BY_SIZE, LIST_BY_TYPE, LIST_CHECK_FOR_ANY_MATCHING_CHILDREN, LIST_DESCENDING, LIST_DIRECTORIES_FIRST, LIST_DIRECTORIES_LAST, LIST_DIRECTORIES_ONLY, LIST_DONT_LIST_HIDDEN_FILES, LIST_DONT_SORT, LIST_FILES_ONLY, LIST_IGNORE_DIRECTORY_STATUS, MEMORY_SYSTEM, OpenFolderIcon, PageIcon, PALM_SYSTEM, pathSeparator, pathSeparatorChar, separator, separatorChar, UNIX_SYSTEM

Fields inherited from interface eve.io.VolumeConstants

VOLUME_FLAG_CDROM, VOLUME_FLAG_FIXED, VOLUME_FLAG_NETWORK, VOLUME_FLAG_RAM, VOLUME_FLAG_REMOVABLE, VOLUME_PROPERTY_BYTES_FREE, VOLUME_PROPERTY_BYTES_TOTAL, VOLUME_PROPERTY_FILESYSTEM_NAME, VOLUME_PROPERTY_NAME

Fields inherited from interface eve.io.FilePermissions

ALL_DOS_FLAGS, ALL_UNIX_PERMISSIONS, FLAG_ARCHIVE, FLAG_HIDDEN, FLAG_READONLY, FLAG_ROM, FLAG_ROMMODULE, FLAG_SYSTEM, FLAG_WINDOWS_ALL_USERS_ACCESS, GROUP_EXECUTE, GROUP_READ, GROUP_WRITE, OTHER_EXECUTE, OTHER_READ, OTHER_WRITE, OWNER_EXECUTE, OWNER_READ, OWNER_WRITE

Constructor Summary

Constructors

Constructor and Description
RapiFile(File parent, String file)
RapiFile(String file)

Method Summary

Modifier and Type	Method and Description
boolean	canWrite()
boolean	createDir() Creates a directory.
boolean	createSymbolicLink(String target) Create a symbolic link to a specified target file.
boolean	delete() Deletes the file or directory.
void	deleteOnExit() This does nothing on a RapiFile.
boolean	exists() Returns true if the file exists and false otherwise.
String	getFullPath()
Wrapper	getInfo(int infoCode, Wrapper sourceParameters, int options)
long	getLength()
File	getNew(File parent, String file) Get a new File object given the directory and new path.
protected long	getSetModified(long value, boolean doGet)
protected int	getSetPermissionsAndFlags(boolean isGet, int valuesToSetOrGet, int valuesToClear) This is used to implement getPermissionsAndFlags() and changePermissionsAndFlags().
int	getSupportedPermissionsAndFlags(int interestedFlags) Returns a value indicating which of the flags specified in the interestedFlags parameter is supported by the underlying system.
boolean	isDirectory() Returns true if the file is a directory and false otherwise.
boolean	isHidden() This returns true if the file should be considered hidden.
boolean	isSymbolicLink() Returns true if the file is a symbolic link.
String[]	list(String mask, int listAndSortOptions) Lists the files contained in a directory.
boolean	move(File newFile) This moves/renames the file to the destination new File.
void	set(File parent, String file) Modifies the File to point to a different file on the file system.
RandomStream	toRandomStream(String mode) Create and return a RandomAccessStream for reading/writing to the data associated with this File object.

Methods inherited from class eve.io.FileAdapter

canRead, getNewInstance, getSymbolicLinkTarget, list, setFullPathName, setInfo, toJavaFile

Methods inherited from class eve.io.File

_jfilegetAbsolutePath, allowAllUsersFullAccess, changePermissionsAndFlags, chmod, chown, createNewFile, createTempFile, createTempFile, equals, filePathsAreEqual, fixupPath, getAbsoluteFile, getAbsolutePath, getBestFileChooser, getCanonicalFile, getCanonicalPath, getChild, getChild, getCopy, getCreationName, getCreationName, getDefaultRoot, getDrivePath, getDrivePath, getFileExt, getFileExt, getFlags, getGroup, getIcon, getInfo, getModified, getName, getNew, getNewFile, getNewFile, getNewFile, getOwner, getParent, getParentFile, getPermissionsAndFlags, getProgramDirectory, getPropertiesString, getSetInfo, getText, getTrueChild, getTrueParent, hashCode, isAbsolute, isFile, isSameFileSystem, isSameVolume, lastModified, list, list, listMultiple, listRoots, listVolumes, makePath, makePath, mkdir, mkdirs, refresh, removeTrailingSlash, removeTrailingSlash, rename, renameTo, roots, setExecutable, setJavaFile, setJavaFile, setLastModified, setModified, setPermissionsAndFlags, setReadable, setReadOnly, setText, setWritable, toReadableStream, toString, toSystemDependantPath, toWritableStream, volumeFlags, volumeProperties, volumes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RapiFile

public RapiFile(String file)

RapiFile

public RapiFile(File parent,
                String file)

Method Detail

getSetPermissionsAndFlags

protected int getSetPermissionsAndFlags(boolean isGet,
                                        int valuesToSetOrGet,
                                        int valuesToClear)
                                 throws IOException

This is used to implement getPermissionsAndFlags() and changePermissionsAndFlags(). It should work like this:

If isGet is true, then the valuesToSetOrGet parameter will hold the flags that the user is interested in.

If isGet is false, then the valuesToSetOrGet parameter will hold the flags to set and the valuesToClear parameter will hold the flags to clear.

The method should return the final flags for the file.

Overrides:

getSetPermissionsAndFlags in class FileAdapter

Throws:

IOException

getSupportedPermissionsAndFlags

public int getSupportedPermissionsAndFlags(int interestedFlags)

Returns a value indicating which of the flags specified in the interestedFlags parameter is supported by the underlying system.

Overrides:

getSupportedPermissionsAndFlags in class FileAdapter

Parameters:

interestedFlags - the flags you wish to check OR'ed together.

Returns:

the supported flags OR'ed together.

createDir

public boolean createDir()

Creates a directory. Returns true if the operation is successful and false otherwise.

Specified by:

createDir in class FileAdapter

createSymbolicLink

public boolean createSymbolicLink(String target)

Create a symbolic link to a specified target file.

Overrides:

createSymbolicLink in class FileAdapter

Parameters:

target - the file to link to.

Returns:

true if created, false if not (if not supported on the platform).

delete

public boolean delete()

Deletes the file or directory. Returns true if the operation is successful and false otherwise.

Specified by:

delete in class FileAdapter

canWrite

public boolean canWrite()

Overrides:

canWrite in class FileAdapter

isHidden

public boolean isHidden()

This returns true if the file should be considered hidden. On Linux/Unix systems files that start with '.' are considered hidden, while on DOS/Windows systems they are hidden if the HIDDEN attribute is set for the file.

Overrides:

isHidden in class File

Returns:

whether the file should be considered hidden on the running platform.

exists

public boolean exists()

Returns true if the file exists and false otherwise.

Specified by:

exists in class FileAdapter

isDirectory

public boolean isDirectory()

Returns true if the file is a directory and false otherwise.

Specified by:

isDirectory in class FileAdapter

isSymbolicLink

public boolean isSymbolicLink()

Returns true if the file is a symbolic link.

Overrides:

isSymbolicLink in class FileAdapter

move

public boolean move(File newFile)

This moves/renames the file to the destination new File. The new File should not exist.

Specified by:

move in class FileAdapter

getLength

public long getLength()

Specified by:

getLength in class FileAdapter

set

public void set(File parent,
                String file)

Description copied from class: File

Modifies the File to point to a different file on the file system. This means that ewe.io.File objects are not immutable, but this avoids a lot of object creation when dealing with large directories.

Overrides:

set in class FileAdapter

getNew

public File getNew(File parent,
                   String file)

Description copied from class: File

Get a new File object given the directory and new path. This is for objects which inherit from File. The default implementation of this will call getNewInstance() and then call set(File directory,String path). If you do not override getNew() you must override getNewInstance().

Overrides:

getNew in class File

getInfo

public Wrapper getInfo(int infoCode,
                       Wrapper sourceParameters,
                       int options)

Overrides:

getInfo in class FileAdapter

getSetModified

protected long getSetModified(long value,
                              boolean doGet)
                       throws IOException

Specified by:

getSetModified in class FileAdapter

Throws:

IOException

getFullPath

public String getFullPath()

Specified by:

getFullPath in class FileAdapter

toRandomStream

public RandomStream toRandomStream(String mode)
                            throws IOException

Create and return a RandomAccessStream for reading/writing to the data associated with this File object.

Overrides:

toRandomStream in class FileAdapter

Parameters:

mode - must be "r" or "rw".

Returns:

An open RandomAccessStream

Throws:

IOException - if an open stream could not be created.

IllegalArgument - exception if mode is not "r" or "rw"

deleteOnExit

public void deleteOnExit()

This does nothing on a RapiFile.

Specified by:

deleteOnExit in class FileAdapter

list

public String[] list(String mask,
                     int listAndSortOptions)

Description copied from class: File

Lists the files contained in a directory. The strings returned are the names of the files and directories contained within this directory. This method returns null if the file is not a directory or if the directory can't be read or if the operation fails. If mask is null or "*" then all files will be listed.

The default method calls the list() method and then splits the returned char array.

Specified by:

list in class FileAdapter

Parameters:

mask - A file mask.

listAndSortOptions - Use the LIST_XXX values OR'ed together.

Returns:

An array of file names.