Package com.scriptbasic.utility.functions.file

Class FileHandlingFunctions

java.lang.Object

com.scriptbasic.utility.functions.file.FileHandlingFunctions

public class FileHandlingFunctions
extends Object

This class implements static methods, which can be used from BASIC programs to access the file system.

Note that these functions are NOT registered into the BASIC interpreter by default. The embedding application has to ask the interpreter to register the methods of this class if it wants BASIC programs access the file system.

Author:

Peter Verhas

Method Summary

Modifier and Type	Method	Description
static String	absoluteFileName(String fileName)
static void	close(FileHandler fh)
static void	deleteFile(String fileName)
static boolean	fileCanExecute(String fileName)
static boolean	fileExists(String fileName)
static boolean	fileIsExecutable(String fileName)
static boolean	fileIsReadable(String fileName)
static boolean	fileIsWritable(String fileName)
static Long	fileLength(String fileName)
static Long	freeSpace(String fileName)
static boolean	isDirectory(String fileName)
static boolean	isFile(String fileName)
static boolean	isHidden(String fileName)
static Long	lastModified(String fileName)
static BasicArray	listFiles(String fileName)
static boolean	mkdir(String fileName)
static FileHandler	open(String fileName, String mode)	Opens a file and returns a file handler.
static String	parentDirectory(String fileName)
static void	printf(FileHandler fh, String line)
static void	printfln(FileHandler fh, String line)
static byte[]	read(FileHandler fh, int len)
static String	readLine(FileHandler fh)
static boolean	renameFile(String fileNameFrom, String fileNameTo)
static boolean	setExecutable(String fileName, boolean executable, boolean ownerOnly)
static boolean	setLastModified(String fileName, Long time)
static boolean	setReadable(String fileName, boolean readable, boolean ownerOnly)
static boolean	setRedOnly(String fileName)
static boolean	setWritable(String fileName, boolean writable, boolean ownerOnly)
static void	write(FileHandler fh, byte[] buffer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

open

public static FileHandler open(String fileName,
 String mode)

Opens a file and returns a file handler. Files can be opened read, write or append. Also the mode can be binary or text. Default is read and text.

Parameters:

fileName - the name of the file to be opened.

mode - the mode how to open the file

Returns:

return value

readLine

public static String readLine(FileHandler fh)
                       throws BasicRuntimeException,
IOException

Throws:

BasicRuntimeException

IOException

read

public static byte[] read(FileHandler fh,
 int len)
                   throws BasicRuntimeException,
IOException

Throws:

BasicRuntimeException

IOException

printf

public static void printf(FileHandler fh,
 String line)
                   throws BasicRuntimeException,
IOException

Throws:

BasicRuntimeException

IOException

printfln

public static void printfln(FileHandler fh,
 String line)
                     throws IOException,
BasicRuntimeException

Throws:

IOException

BasicRuntimeException

write

public static void write(FileHandler fh,
 byte[] buffer)
                  throws BasicRuntimeException,
IOException

Throws:

BasicRuntimeException

IOException

close

public static void close(FileHandler fh)
                  throws Exception

Throws:

Exception

deleteFile

public static void deleteFile(String fileName)

fileExists

public static boolean fileExists(String fileName)

fileCanExecute

public static boolean fileCanExecute(String fileName)

fileIsReadable

public static boolean fileIsReadable(String fileName)

fileIsWritable

public static boolean fileIsWritable(String fileName)

fileIsExecutable

public static boolean fileIsExecutable(String fileName)

isDirectory

public static boolean isDirectory(String fileName)

isFile

public static boolean isFile(String fileName)

absoluteFileName

public static String absoluteFileName(String fileName)

freeSpace

public static Long freeSpace(String fileName)

parentDirectory

public static String parentDirectory(String fileName)

isHidden

public static boolean isHidden(String fileName)

mkdir

public static boolean mkdir(String fileName)

renameFile

public static boolean renameFile(String fileNameFrom,
 String fileNameTo)

setExecutable

public static boolean setExecutable(String fileName,
 boolean executable,
 boolean ownerOnly)

setReadable

public static boolean setReadable(String fileName,
 boolean readable,
 boolean ownerOnly)

setWritable

public static boolean setWritable(String fileName,
 boolean writable,
 boolean ownerOnly)

setRedOnly

public static boolean setRedOnly(String fileName)

lastModified

public static Long lastModified(String fileName)

fileLength

public static Long fileLength(String fileName)

setLastModified

public static boolean setLastModified(String fileName,
 Long time)

listFiles

public static BasicArray listFiles(String fileName)
                            throws ScriptBasicException

Throws:

ScriptBasicException