Class jls.io.File

This class represents a file system entry.
Defined in: File.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
jls.io.File(parent, child)
Creates a file.
Method Summary
Method Attributes Method Name and Description
<static>  
jls.io.File.concat(a, b)
Concats to path parts and then returns the resulting path.
 
exists()
Tests whether this file exists.
 
getAbsolutePath()
Returns the absolute path of this file.
 
getExtension()
Returns the extension of this file.
 
getName()
Returns the name of this file.
 
getPath()
Returns the path of this file.
 
isAbsolute()
Tests whether the file path is absolute.
 
isDirectory()
Tests whether the file entry is a directory.
 
isFile()
Tests whether the file entry is a file.
 
length()
Returns the length of the file entry represented by this file.
 
list()
Returns an array of strings naming the file system entries in the directory represented by this file.
 
listFiles()
Returns an array of files in the directory represented by this file.
<static>  
jls.io.File.listRoots()
Returns an array of file system roots.
 
mkdir()
Creates the directory named by this file.
<static>  
jls.io.File.normalize(path)
Normalizes a path.
 
remove()
Removes the file entry.
 
renameTo(newPath)
Renames this file.
Class Detail
jls.io.File(parent, child)
Creates a file.
Parameters:
{jls.io.File} parent Optional
The parent file.
{String} child
The file pathname.
Method Detail
<static> {String} jls.io.File.concat(a, b)
Concats to path parts and then returns the resulting path.
Parameters:
{String} a
The first path part to concat.
{String} b
The last path part to concat.
Returns:
{String} The concated path.
{Boolean} exists()
Tests whether this file exists.
Returns:
{Boolean} true if the file exists.
{String} getAbsolutePath()
Returns the absolute path of this file.
Returns:
{String} The absolute path of this file.
{String} getExtension()
Returns the extension of this file.
Returns:
{String} The extension of this file.
{String} getName()
Returns the name of this file. This is the last name in the pathname's name sequence.
Returns:
{String} The name of this file.
{String} getPath()
Returns the path of this file.
Returns:
{String} The path of this file.
{Boolean} isAbsolute()
Tests whether the file path is absolute.
Returns:
{Boolean} true if the file path is absolute.
{Boolean} isDirectory()
Tests whether the file entry is a directory.
Returns:
{Boolean} true if the file entry is a directory.
{Boolean} isFile()
Tests whether the file entry is a file.
Returns:
{Boolean} true if the file entry is a file.
{Number} length()
Returns the length of the file entry represented by this file.
Returns:
{Number} The length of the file entry represented by this file.
{Array} list()
Returns an array of strings naming the file system entries in the directory represented by this file.
Returns:
{Array} An array of strings naming the file system entries.
{Array} listFiles()
Returns an array of files in the directory represented by this file.
Returns:
{Array} An array of files.
<static> {Array} jls.io.File.listRoots()
Returns an array of file system roots.
Returns:
{Array} An array of files denoting the available filesystem roots.
{Boolean} mkdir()
Creates the directory named by this file.
Returns:
{Boolean} true if the directory is created.
<static> {String} jls.io.File.normalize(path)
Normalizes a path.
Parameters:
{String} path
The path to normalize.
Returns:
{String} The normalized path.
{Boolean} remove()
Removes the file entry.
Returns:
{Boolean} true if the entry is removed.
{Boolean} renameTo(newPath)
Renames this file.
Parameters:
{String} newPath
The new path for this file.
Returns:
{Boolean} true if this file is renamed.
Documentation generated by JsDoc Toolkit 2.3.2 on Sat Jan 08 2011 02:00:13 GMT+0100 (CET)