Jaxer.Filesystem : Object
Return to: Jaxer Framework index

Platform Support

Jaxer Server Framework Jaxer Client Framework
0.9 no

Constructors

Constructor Action Jaxer Server Framework Jaxer Client Framework
Jaxer.Filesystem Constructor(Object fsPath) : Jaxer.Filesystem
File System Object. This object is used as a functional wrapper to the file system. It can represent, folders, files, symlinks
 Show Details 0.9 no

Jaxer.Filesystem(Object fsPath) : Jaxer.Filesystem

File System Object. This object is used as a functional wrapper to the file system. It can represent, folders, files, symlinks

Parameters
Object fsPath The path to the filesystem object

Returns
Jaxer.Filesystem Returns an instance of Filesystem.

Functions

Method Action Jaxer Server Framework Jaxer Client Framework
append(String leafname) : String
Changes the path of the filesystem object by appending the provided leaf value.
 Show Details 0.9 no

Parameters
String leafname The leafname to be appended

Returns
String The appended directory and leafname

Throws
Throws a Exception containing the error code.
appendRelativePath(String relative) : void
This method is used for appending a relative path to the current filesystem object
 Show Details 0.9 no

Parameters
String relative path

Throws
Throws a Exception containing the error code.
equals(Object a) : Boolean
Evaluates whether the current filesystem object refers to the same file as the one provided as a parameter
 Show Details 0.9 no

Parameters
Object a file system object to be compared

Returns
Boolean true if object refers to same filesystem object, false otherwise

Throws
Throws a Exception containing the error code.
exists() : Boolean
A boolean indicator of whether the referenced object physically exists on the filesystem.
 Show Details 0.9 no

Returns
Boolean true if file exists otherwise false

getDateModified() : Object
The last modified timestamp as reported by the OS WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
 Show Details 0.9 no

Returns
Object a date object representing the last modified timestamp of the file

Throws
Throws a Exception containing the error code.
getLeaf() : String
Returns the leaf (filename + extension) portion of the file path
 Show Details 0.9 no

Returns
String The derived URL spec from the file

getNsIFile(String aPermissions) : Object
Returns a clone of the underlying nsIFile object! WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
 Show Details 0.9 no

Parameters
String aPermissions

Returns
Object clone of the contained nsIFile

Throws
Throws a Exception containing the error code.
getParentPath() : String
Returns the path of the parent filesystem object. if called on the root filesystem object an exception will be thrown. WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
Show Details 0.9 no

Returns
String The path of the parent file system object

getPath() : String
Returns the path of the refererenced filesystem object WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
 Show Details 0.9 no

Returns
String path to nsIFile

Throws
Throws a Exception containing the error code.
getPermissions() : String
Get the file permissions for the File object The permissions for the filesystem object, this may be ignored/misreported by some versions of windows. WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
Show Details 0.9 no

Returns
String the chmod style permissions of the file

Throws
Throws a Exception containing the error code.
getURL() : String
Return the path of the referenced object as a file URL WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
 Show Details 0.9 no

Returns
String The derived URL spec from the file

initPath(Array a) : String
This method will initialize the file system object with the provided path information (or will attempt to derive the path if an object is provided). An existing File object can be 'repointed' to a new physical file sytem object by invoking this method.
Show Details 0.9 no

Parameters
Array a set of arguments

Returns
String the file extension of the referenced filesystem object

Throws
Throws a Exception containing the error code.
isDir() : Boolean
A boolean indicator of whether the referenced object is a folder/directory
 Show Details 0.9 no

Returns
Boolean true if item a folder

isExec() : Boolean
A boolean indicator of whether the referenced object is an executable
 Show Details 0.9 no

Returns
Boolean true if item executable

isFile() : Boolean
A boolean indicator of whether the referenced object is a file
 Show Details 0.9 no

Returns
Boolean true if item is a file

isHidden() : Boolean
A boolean indicator of whether the referenced object is hidden
 Show Details 0.9 no

Returns
Boolean true if item is hidden

isReadable() : Boolean
A boolean indicator of whether the referenced object is readable
 Show Details 0.9 no

Returns
Boolean true if item is readable

isSpecial() : Boolean
A boolean indicator of whether the referenced object is special. NOTE: Not implemented on Mac and possibly other systems.
 Show Details 0.9 no

Returns
Boolean true if item a special file

isSymlink() : Boolean
A boolean indicator of whether the referenced object is a symlink
 Show Details 0.9 no

Returns
Boolean true if item symbolic link

isWritable() : Boolean
A boolean indicator of whether the referenced object is writable
 Show Details 0.9 no

Returns
Boolean true if item is writable

move(String destination) : void
Move the referenced file to a new filesystem location provided as a parameter NOTE: after a move, 'this' will be reinitialized to reference the moved file!
Show Details 0.9 no

Parameters
String destination path

Throws
Throws a Exception containing the error code.
normalize() : void
As of Mozilla 1.7, the underlying XPCOM method is only implemented under UNIX builds (except for Mac OSX). This method will fail if the path does not exist.
Show Details 0.9 no
Throws
Throws a Exception containing the error code.
resetCache() : Boolean
Truncates the file referenced by the filesystem object.
 Show Details 0.9 no

Returns
Boolean true indicates success

Throws
Throws a Exception containing the error code.
setLeaf(Object aLeaf) : void
Sets the leaf (filename + extension) portion of the file path WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
 Show Details 0.9 no

Parameters
Object aLeaf The new filename + extension string

setPermissions(Number aPermissions) : void
Set the file permissions for the File object this may be ignored/misreported by some versions of windows. on Windows, you can only set the Read/Write bits of a file. And User/Group/Other will have the SAME settings based on the most-relaxed setting (Read 04, 040, 0400, Write 02, 020, 0200). When a file is created, by default it has both Read and Write permissions. Also, you cannot set the file permission to WRITE-ONLY, doing so would set it to read-write WORKAROUND PENDING FF3 GETTER ISSUE RESOLUTION
Show Details 0.9 no

Parameters
Number aPermissions The chmod style permissions value

Throws
Throws a Exception containing the error code.
aptana_docs