All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.bulletproof.io.File 

java.lang.Object
   |
   +----com.bulletproof.io.File
public class File
extends Object
A class that includes a set of special functions

Variable Index

o CREATE
Create open mode.
o DONT_OPEN
Don't open the file mode.
o READ_ONLY
Read-only open mode.
o READ_WRITE
Read-write open mode.
o WRITE_ONLY
Write-only open mode.

Constructor Index

o File(String, int)
Opens a file with the given name and mode.

Method Index

o close()
Closes the file.
o createDir()
Creates a directory.
o delete()
Deletes the file or directory.
o exists()
Returns true if the file exists and false otherwise.
o getLength()
Returns the length of the file in bytes.
o getPath()
Return the file's path.
o isDir()
Returns true if the file is a directory and false otherwise.
o isOpen()
Returns true if the file is open for reading or writing and false otherwise.
o listDir()
Lists the files contained in a directory.
o readBytes(byte[], int, int)
Reads bytes from the file into a byte array.
o rename(String)
Renames the file.
o seek(int)
Sets the file pointer for read and write operations to the given position.
o writeBytes(byte[], int, int)
Writes to the file.

Variables

o DONT_OPEN 
 public static final int DONT_OPEN
Don't open the file mode.

o READ_ONLY 
 public static final int READ_ONLY
Read-only open mode.

o WRITE_ONLY 
 public static final int WRITE_ONLY
Write-only open mode.

o READ_WRITE 
 public static final int READ_WRITE
Read-write open mode.

o CREATE 
 public static final int CREATE
Create open mode. Used to create a file if one does not exist.

Constructors

o File 
 public File(String path,
             int mode)
Opens a file with the given name and mode. If mode is CREATE, the file will be created if it does not exist. The DONT_OPEN mode allows the exists(), rename(), delete(), listDir(), createDir() and isDir() methods to be called without requiring the file to be open for reading or writing.

Parameters:
path - the file's path
mode - one of DONT_OPEN, READ_ONLY, WRITE_ONLY, READ_WRITE or CREATE

Methods

o close 
 public boolean close()
Closes the file. Returns true if the operation is successful and false otherwise.

o isOpen 
 public boolean isOpen()
Returns true if the file is open for reading or writing and false otherwise. This can be used to check if opening or creating a file was successful.

o createDir 
 public boolean createDir()
Creates a directory. Returns true if the operation is successful and false otherwise.

o delete 
 public boolean delete()
Deletes the file or directory. Returns true if the operation is successful and false otherwise.

o exists 
 public boolean exists()
Returns true if the file exists and false otherwise.

o getLength 
 public int getLength()
Returns the length of the file in bytes. If the file is not open 0 will be returned.

o getPath 
 public String getPath()
Return the file's path.

o isDir 
 public boolean isDir()
Returns true if the file is a directory and false otherwise.

o listDir 
 public String[] listDir()
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 directory can't be read or if the operation fails.

o readBytes 
 public int readBytes(byte b[],
                      int off,
                      int len)
Reads bytes from the file into a byte array. Returns the number of bytes actually read or -1 if an error prevented the read operation from occurring. After the read is complete, the location of the file pointer (where read and write operations start from) is advanced the number of bytes read.

Parameters:
buf - the byte array to read data into
start - the start position in the array
count - the number of bytes to read
o writeBytes 
 public int writeBytes(byte b[],
                       int off,
                       int len)
Writes to the file. Returns the number of bytes written or -1 if an error prevented the write operation from occurring. After the write is complete, the file pointer (where read and write operations start from) is advanced the number of bytes written.

Parameters:
buf - the byte array to write data from
start - the start position in the byte array
count - the number of bytes to write
o rename 
 public boolean rename(String path)
Renames the file. If the path given is in a different directory, the existing file will be moved to the directory in the specified path. Returns true if the renaming was successful and false otherwise.

o seek 
 public boolean seek(int pos)
Sets the file pointer for read and write operations to the given position. The position passed is an absolute position, in bytes, from the beginning of the file. To set the position to just after the end of the file, you can call: 
 file.seek(file.getLength());
True is returned if the operation is successful and false otherwise. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index