eve.io

Class FileAdapter

java.lang.Object

eve.io.File

eve.io.FileAdapter

All Implemented Interfaces:

FileConstants, FilePermissions, VolumeConstants, Textable

Direct Known Subclasses:

FileStoreEntryFile, RapiFile, RemoteFile

public abstract class FileAdapter
extends File

Author:

Michael L Brereton

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

Modifier	Constructor and Description
protected	FileAdapter()
protected	FileAdapter(File directory, String name)
protected	FileAdapter(String name)

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Returns true if the file exists and can be read.
boolean	canWrite()
abstract boolean	createDir()
boolean	createSymbolicLink(String target) Create a symbolic link to a specified target file.
abstract boolean	delete()
abstract void	deleteOnExit()
abstract boolean	exists()
abstract String	getFullPath()
Wrapper	getInfo(int infoCode, Wrapper sourceParameters, int options)
abstract long	getLength()
protected File	getNewInstance()
protected abstract long	getSetModified(long time, 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.
File	getSymbolicLinkTarget() If this file is a symbolic link, return the target of the link.
abstract boolean	isDirectory()
boolean	isSymbolicLink()
abstract String[]	list(String mask, int listAndSortOptions) Lists the files contained in a directory.
CharArray	list(String mask, int listAndSortOptions, CharArray dest)
abstract boolean	move(File newFile)
void	set(File parent, String name) Modifies the File to point to a different file on the file system.
protected void	setFullPathName(File parent, String file)
boolean	setInfo(int infoCode, Wrapper sourceParameters, int options)
File	toJavaFile() This returns null by default - since a FileAdapter does not represent an OS File.
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.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, getNew, getNewFile, getNewFile, getNewFile, getOwner, getParent, getParentFile, getPermissionsAndFlags, getProgramDirectory, getPropertiesString, getSetInfo, getText, getTrueChild, getTrueParent, hashCode, isAbsolute, isFile, isHidden, 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

FileAdapter

protected FileAdapter()

FileAdapter

protected FileAdapter(String name)

FileAdapter

protected FileAdapter(File directory,
                      String name)

Method Detail

set

public void set(File parent,
                String name)

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 File

setFullPathName

protected void setFullPathName(File parent,
                               String file)

canRead

public boolean canRead()

Description copied from class: File

Returns true if the file exists and can be read.

Overrides:

canRead in class File

canWrite

public boolean canWrite()

Overrides:

canWrite in class File

getNewInstance

protected File getNewInstance()

Overrides:

getNewInstance in class File

createDir

public abstract boolean createDir()

Overrides:

createDir in class File

delete

public abstract boolean delete()

Overrides:

delete in class File

exists

public abstract boolean exists()

Overrides:

exists in class File

isDirectory

public abstract boolean isDirectory()

Overrides:

isDirectory in class File

isSymbolicLink

public boolean isSymbolicLink()

Overrides:

isSymbolicLink in class File

getFullPath

public abstract String getFullPath()

Overrides:

getFullPath in class File

deleteOnExit

public abstract void deleteOnExit()

Overrides:

deleteOnExit in class File

list

public final CharArray list(String mask,
                            int listAndSortOptions,
                            CharArray dest)
                     throws IOException

Overrides:

list in class File

Throws:

IOException

list

public abstract 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.

Overrides:

list in class File

Parameters:

mask - A file mask.

listAndSortOptions - Use the LIST_XXX values OR'ed together.

Returns:

An array of file names.

getSetModified

protected abstract long getSetModified(long time,
                                       boolean doGet)
                                throws IOException

Overrides:

getSetModified in class File

Throws:

IOException

move

public abstract boolean move(File newFile)

Overrides:

move in class File

getInfo

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

Overrides:

getInfo in class File

setInfo

public boolean setInfo(int infoCode,
                       Wrapper sourceParameters,
                       int options)

Overrides:

setInfo in class File

getLength

public abstract long getLength()

Overrides:

getLength in class File

getSetPermissionsAndFlags

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

Description copied from class: File

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 any of these flags are invalid on this system an IllegalArgumentException should be thrown. Otherwise the current state of the flags should be returned - it is OK to return extra flags even if they are not specified as flags 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. If any of these are not valid then an IllegalArgumentException should be thrown. Otherwise the flags should be changed and then the state of the flags AFTER the change has been made should be returned.

Overrides:

getSetPermissionsAndFlags in class File

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 File

Parameters:

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

Returns:

the supported flags OR'ed together.

createSymbolicLink

public boolean createSymbolicLink(String target)

Create a symbolic link to a specified target file.

Overrides:

createSymbolicLink in class File

Parameters:

target - the file to link to.

Returns:

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

getSymbolicLinkTarget

public File getSymbolicLinkTarget()

If this file is a symbolic link, return the target of the link.

Overrides:

getSymbolicLinkTarget in class File

Returns:

the target of the symbolic link.

toJavaFile

public File toJavaFile()

This returns null by default - since a FileAdapter does not represent an OS File.

Overrides:

toJavaFile in class File

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 File

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"