Class File

Object
   |
   +--File

class File

Defined in file.js

Field Detail

ext

string ext

lastModified

int lastModified

leaf

string leaf

name

string name

nsIFile

nsIFile nsIFile

path

string path

permissions

int permissions

File

File( aPath )

Parameters:
aeither - a string file uri path, nsIURI with 'file' scheme, or native string file uri (eg "/tmp/blah/" on mac/linux)

append

boolean append( <string> arg )

Constructs a descendent of the current file. This operation only has meaning if the current file either doesn't exist or is a directory.

Parameters:
arg - name of the new descendent.

Returns:
whether the operation was successful

canRead

boolean canRead( )

Tests whether this file can be read with the current permissions. Requires file to exist.

canWrite

boolean canWrite( )

Tests whether this file can be written to with the current permissions. Requires file to exist.

close

void close( )

Closes the current file object to further reading or writing. Requires file to exist

create

void create( type )

Creates the file in the filesystem.

Parameters:
arg - "dir": to create a directory; "file" to create a file.

Returns:

Throws:
- Exception if any error occurs

exists

boolean exists( )

Whether the file exists in the filesystem or not

Returns:
whether the file exists or not

Throws:
- ReferenceError if not initialized

getExtension

string getExtension( )

Returns everything after the name. An extension begins after the first instance of '.'. If there is no extension, the empty string "" is returned.

getLastModified

int getLastModified( )

Returns the the last time this file object was modified Requires file to exist.

Returns:
number of milliseconds from midnight (00:00:00), January 1, 1970 Greenwich Mean Time (GMT).

getLeaf

string getLeaf( )

Returns everything after the path

getName

string getName( )

Returns everything after the path and before the extension. If there is no extension or if the file is hidden, this is the same as getLeaf()

getNSIFile

nsIFIle getNSIFile( )

Returns:
mozilla file object

getParent

File getParent( )

Returns a File instance of this object's parent

Returns:
the parent File object or null if an error orccurs

getPath

Object getPath( <string> type )

Parameters:
type - specifying format of path to return. Either "native": platorm native path; "uri": an nsIURI object; "": uri as a string

Returns:
path of this file

getPermissions

int getPermissions( )

Returns the permissions of the current file object. Requires file to exist.

Returns:
the integer 10 prepended to the hexadecimal permissions value

isDir

boolean isDir( )

Tests whether this object represents a directory.

Returns:
true if it's a directory, false if not or an error occurs

isFile

boolean isFile( )

Tests whether this object represents a file.

Returns:
true if it's a file, false if not or an error occurs

move

boolean move( <Object> arg )

Requires the file to exist.

Parameters:
arg - nsIFile, nsIURI, string path, or another File object where the current file will be moved to

Returns:
if the move was successful

open

boolean open( <string> arg )

Prepares the current file object for reading or writing. Will attempt to create the file if it does not already exist.

Parameters:
arg - "r" for read, "w" for write, "a" for append

Returns:
success

read

string read( <int> size )

Performs a read on the underlying file object. File must exist and be open() for reading.

Parameters:
size - How much to read, assumed to be nsIFile.fileSize if not specified

Returns:
Data (in string form) from the file

See:
- open()

readAllLines

array readAllLines( )

Reads all lines of the file into an Array object If another type of read operation has or will be performed, a close() and open() must be done first.

Returns:
All lines of data from the file

readBase64

string readBase64( )

Read the entire file with Base64 encoding. The file is read as a single line, not 80 character \n terminated lines. File must exist and be open() for reading.

Returns:
the file's contents Base64 encoded

See:
- readByteArray()

readByteArray

array readByteArray( )

Read the file as an array of bytes. File must exist and be open() for reading.

Returns:
An Array of bytes

readLine

string readLine( )

Reads a single line of string text terminated by a CR, LF, CRLF, LFCR, or eof. The line terminator is not returned. If another type of read operation has or will be performed, a close() and open() must be done first.

Returns:
A line of data from the file

remove

boolean remove( )

Removes the current file from the filesystem. Requires the file to exist.

Returns:
whether the operation was successful

rename

boolean rename( <string> arg )

Renames the file. Requires the file to exist.

Parameters:
arg - new name.

Returns:
if the move was successful

setPermissions

void setPermissions( <int> arg )

Sets permissions of the current file object. Requires file to exist.

Parameters:
arg - A hexadecimal value: eg 0664

write

boolean write( arg )

Performs a write on the underlying nsIFile object. File must exist and be open() for writing or appending.

Parameters:
What - to write

Returns:
true if successful

See:
- open()