File Class Reference

File access class. More...

Inheritance diagram for File:

[legend]Collaboration diagram for File:

[legend]List of all members.

Public Member Functions

• void File (String path)

  Create new File object.
  

• void remove (bool recursive)

  Remove file or directory.
  

• void createDirectory (int perms)

  Creates new directory.
  

• void close ()

  Close file.
  

• void write (String data)

  Write data to file.
  

• void open (String charset, int mode, int perms)

  Open file.
  

• void flush ()

  Flushes output buffer.
  

Public Attributes

• int MODE_APPEND

  Flag used by open() method.
  

• int MODE_SYNC

  Flag used by open() method.
  

• nsILocalFile file

  Implementation of nsILocalFile interface used to handle this file object.
  

• int MODE_CREATE

  Flag used by open() method.
  

• int size

  Size of file.
  

• int MODE_RDONLY

  Flag used by open() method.
  

• int MODE_RDWR

  Flag used by open() method.
  

• int MODE_WRONLY

  Flag used by open() method.
  

• String path

  String with full path to our file.
  

• nsIURI uri

  This file uri.
  

• int MODE_TRUNCATE

  Flag used by open() method.
  

• int MODE_EXCL

  Flag used by open() method.
  

• bool exists

  true if file (or directory) with this path exists.
  

---

Detailed Description

File access class.

---

Constructor & Destructor Documentation

void File (  String  path  )

Create new File object. Parameters: path  File path. This can be also nsIURI object with "file" scheme. Exceptions: IOError  Thrown on IO errors.

---

Member Function Documentation

void createDirectory (  int  perms  )

Creates new directory. Parameters: perms  Unix permisions bits for new directory. By defaulr value of 0755 will be used. (optional) Exceptions: IOError  Thrown on any IO error.

void flush (   )

Flushes output buffer. Exceptions: IOError  Thrown on any IO error.

void open (  String  charset, int  mode, int  perms )

Open file. Parameters: charset  Name of charset in which file is coded. Reader.read() and write() methods performs conversion in-the-fly. (optional) mode  Open mode, bit mask of MODE_* attributes. perms  Unix like file permisions code. Used on file creation. By default 0644 value is used. (optional). Exceptions: IOError  Thrown on any IO error.

void remove (  bool  recursive  )

Remove file or directory. Parameters: recursive  If set to true this operation will delete not empty directories with all it contents. Exceptions: IOError  Thrown on any IO error.

void write (  String  data  )

Write data to file. Parameters: data  Data to write. Exceptions: IOError  Thrown on any IO error. CharsetConvertError  Thrown when charset conversion fails.

---

The documentation for this class was generated from the following file:

• file.js

---