Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyFileSystem

@Type("filesystem")
public interface PsyFileSystem

An utility class providing filesystem-related methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_CHANGEFILEPERMISSIONS	Context action of the changefilepermissions operator.
static final ContextAction	PSY_COPYFILE	Context action of the copyfile operator.
static final ContextAction	PSY_CREATEDIRECTORY	Context action of the createdirectory operator.
static final ContextAction	PSY_CURRENTDIRECTORY	Context action of the currentdirectory operator.
static final ContextAction	PSY_DELETEFILE	Context action of the deletefile operator.
static final ContextAction	PSY_FILEABSOLUTEPATH	Context action of the fileabsolutepath operator.
static final ContextAction	PSY_FILEACCESSTIME	Context action of the fileaccesstime operator.
static final ContextAction	PSY_FILEATTRIBUTE	Context action of the fileattribute operator.
static final ContextAction	PSY_FILECREATIONTIME	Context action of the filecreationtime operator.
static final ContextAction	PSY_FILEEXISTS	Context action of the fileexists operator.
static final ContextAction	PSY_FILEMODIFIEDTIME	Context action of the filemodifiedtime operator.
static final ContextAction	PSY_FILEPERMISSIONS	Context action of the filepermissions operator.
static final ContextAction	PSY_FILES	Context action of the files operator.
static final ContextAction	PSY_FILESIZE	Context action of the filesize operator.
static final ContextAction	PSY_HARDLINK	Context action of the hardlink operator.
static final ContextAction	PSY_ISDIRECTORY	Context action of the isdirectory operator.
static final ContextAction	PSY_ISFILE	Context action of the isfile operator.
static final ContextAction	PSY_ISSAMEFILE	Context action of the issamefile operator.
static final ContextAction	PSY_ISSYMLINK	Context action of the issymlink operator.
static final ContextAction	PSY_READLINK	Context action of the readlink operator.
static final ContextAction	PSY_RENAMEFILE	Context action of the renamefile operator.
static final ContextAction	PSY_SYMLINK	Context action of the symlink operator.

Method Summary

Static Methods

Modifier and Type	Method	Description
static void	psyChangeFileAttribute(PsyString oFileName, PsyString oAttribute, PsyString oValue)
static void	psyChangeFilePermissions(PsyString oFileName, PsyInteger oPermissions)
static void	psyCopyFile(PsyString oSourceName, PsyString oTargetName)	Copies a file to the target file.
static void	psyCreateDirectory(PsyString oFileName)	Creates a new directory with the given name.
static PsyString	psyCurrentDirectory()	Returns a string representing the absolute name of the current directory.
static void	psyDeleteFile(PsyString oFileName)	Deletes a file or empty directory with a given name.
static PsyString	psyFileAbsolutePath(PsyString oFileName)	Returns a string representing the absolute path to given file.
static PsyInteger	psyFileAccessTime(PsyString oFileName)
static PsyObject	psyFileAttribute(PsyString oFileName, PsyString oAttribute)
static PsyInteger	psyFileCreationTime(PsyString oFileName)
static PsyBoolean	psyFileExists(PsyString oFileName)
static PsyInteger	psyFileModifiedTime(PsyString oFileName)
static PsyInteger	psyFilePermissions(PsyString oFileName)
static PsyFormalStream<PsyString>	psyFiles(PsyString oFileName)	Returns a lazily populated stream, the elements of which are the entries in the directory.
static PsyInteger	psyFileSize(PsyString oFileName)	Returns the integer representing the size (in bytes) for the file or directory with the given name.
static void	psyHardlink(PsyString oExisting, PsyString oLink)	Creates a new link (directory entry) for an existing file.
static PsyBoolean	psyIsDirectory(PsyString oFileName)
static PsyBoolean	psyIsFile(PsyString oFileName)
static PsyBoolean	psyIsSameFile(PsyString oFileName1, PsyString oFileName2)
static PsyBoolean	psyIsSymlink(PsyString oFileName)
static PsyString	psyReadLink(PsyString oFileName)	Returns the target of a symbolic link.
static void	psyRenameFile(PsyString oFileName1, PsyString oFileName2)
static void	psySymlink(PsyString oTarget, PsyString oLink)	Creates a symbolic link to a target.

Field Details

PSY_CHANGEFILEPERMISSIONS

@OperatorType("changefilepermissions")
static final ContextAction PSY_CHANGEFILEPERMISSIONS

Context action of the changefilepermissions operator.

PSY_COPYFILE

@OperatorType("copyfile")
static final ContextAction PSY_COPYFILE

Context action of the copyfile operator.

PSY_CREATEDIRECTORY

@OperatorType("createdirectory")
static final ContextAction PSY_CREATEDIRECTORY

Context action of the createdirectory operator.

PSY_CURRENTDIRECTORY

@OperatorType("currentdirectory")
static final ContextAction PSY_CURRENTDIRECTORY

Context action of the currentdirectory operator.

PSY_DELETEFILE

@OperatorType("deletefile")
static final ContextAction PSY_DELETEFILE

Context action of the deletefile operator.

PSY_FILEACCESSTIME

@OperatorType("fileaccesstime")
static final ContextAction PSY_FILEACCESSTIME

Context action of the fileaccesstime operator.

PSY_FILEABSOLUTEPATH

@OperatorType("fileabsolutepath")
static final ContextAction PSY_FILEABSOLUTEPATH

Context action of the fileabsolutepath operator.

PSY_FILEATTRIBUTE

@OperatorType("fileattribute")
static final ContextAction PSY_FILEATTRIBUTE

Context action of the fileattribute operator.

PSY_FILECREATIONTIME

@OperatorType("filecreationtime")
static final ContextAction PSY_FILECREATIONTIME

Context action of the filecreationtime operator.

PSY_FILEEXISTS

@OperatorType("fileexists")
static final ContextAction PSY_FILEEXISTS

Context action of the fileexists operator.

PSY_FILEMODIFIEDTIME

@OperatorType("filemodifiedtime")
static final ContextAction PSY_FILEMODIFIEDTIME

Context action of the filemodifiedtime operator.

PSY_FILEPERMISSIONS

@OperatorType("filepermissions")
static final ContextAction PSY_FILEPERMISSIONS

Context action of the filepermissions operator.

PSY_FILES

@OperatorType("files")
static final ContextAction PSY_FILES

Context action of the files operator.

PSY_FILESIZE

@OperatorType("filesize")
static final ContextAction PSY_FILESIZE

Context action of the filesize operator.

PSY_HARDLINK

@OperatorType("hardlink")
static final ContextAction PSY_HARDLINK

Context action of the hardlink operator.

PSY_ISDIRECTORY

@OperatorType("isdirectory")
static final ContextAction PSY_ISDIRECTORY

Context action of the isdirectory operator.

PSY_ISFILE

@OperatorType("isfile")
static final ContextAction PSY_ISFILE

Context action of the isfile operator.

PSY_ISSAMEFILE

@OperatorType("issamefile")
static final ContextAction PSY_ISSAMEFILE

Context action of the issamefile operator.

PSY_ISSYMLINK

@OperatorType("issymlink")
static final ContextAction PSY_ISSYMLINK

Context action of the issymlink operator.

PSY_READLINK

@OperatorType("readlink")
static final ContextAction PSY_READLINK

Context action of the readlink operator.

PSY_RENAMEFILE

@OperatorType("renamefile")
static final ContextAction PSY_RENAMEFILE

Context action of the renamefile operator.

PSY_SYMLINK

@OperatorType("symlink")
static final ContextAction PSY_SYMLINK

Context action of the symlink operator.

Method Details

psyCreateDirectory

static void psyCreateDirectory(PsyString oFileName)
                        throws PsyFileExistsException,
PsyFileAccessDeniedException,
PsySecurityErrorException,
PsyIOErrorException

Creates a new directory with the given name.

Parameters:

oFileName - a string representing the name of the directory being created.

Throws:

PsyFileExistsException - when the directory already exists.

PsyFileAccessDeniedException - when the operation is prohibited due to a file permission or other access check.

PsySecurityErrorException - when security policy is violated.

PsyIOErrorException - when an I/O error occurs.

psyDeleteFile

static void psyDeleteFile(PsyString oFileName)
                   throws PsyFileNotFoundException,
PsyFileAccessDeniedException,
PsyDirectoryNotEmptyException,
PsySecurityErrorException,
PsyIOErrorException

Deletes a file or empty directory with a given name.

Parameters:

oFileName - a string representing the name of a file or directory.

Throws:

PsyDirectoryNotEmptyException - when the directory is not empty.

PsyFileNotFoundException - when the file or directory does not exist.

PsyFileAccessDeniedException - when the operation is prohibited due to a file permission or other access check.

PsySecurityErrorException - when security policy is violated.

PsyIOErrorException - when an I/O error occurs.

psyCopyFile

static void psyCopyFile(PsyString oSourceName,
 PsyString oTargetName)
                 throws PsyDirectoryNotEmptyException,
PsyFileAccessDeniedException,
PsyFileExistsException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException,
PsyUnsupportedException

Copies a file to the target file.

Parameters:

oSourceName - a string name of the file to copy.

oTargetName - a string name of the target file.

Throws:

PsyDirectoryNotEmptyException - TODO

PsyFileExistsException - TODO

PsyFileNotFoundException - when the file or directory does not exist.

PsyFileAccessDeniedException - when the operation is prohibited due to a file permission or other access check.

PsySecurityErrorException - when security policy is violated.

PsyIOErrorException - when an I/O error occurs.

PsyUnsupportedException - TODO

psyReadLink

static PsyString psyReadLink(PsyString oFileName)
                      throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsyNotLinkException,
PsySecurityErrorException

Returns the target of a symbolic link.

Parameters:

oFileName - the name of the target file.

Returns:

the target of a symbolic link

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsyNotLinkException

PsySecurityErrorException

psySymlink

static void psySymlink(PsyString oTarget,
 PsyString oLink)
                throws PsyFileAccessDeniedException,
PsyFileExistsException,
PsyIOErrorException,
PsySecurityErrorException,
PsyUnsupportedException

Creates a symbolic link to a target.

Parameters:

oTarget - the target of the symbolic link.

oLink - the path of the symbolic link to create.

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileExistsException

PsySecurityErrorException

PsyUnsupportedException

psyHardlink

static void psyHardlink(PsyString oExisting,
 PsyString oLink)
                 throws PsyFileAccessDeniedException,
PsyFileExistsException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException,
PsyUnsupportedException

Creates a new link (directory entry) for an existing file.

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileExistsException

PsyFileNotFoundException

PsySecurityErrorException

PsyUnsupportedException

psyRenameFile

static void psyRenameFile(PsyString oFileName1,
 PsyString oFileName2)
                   throws PsyDirectoryNotEmptyException,
PsyFileAccessDeniedException,
PsyFileExistsException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyDirectoryNotEmptyException

PsyFileAccessDeniedException

PsyFileExistsException

PsyFileNotFoundException

PsySecurityErrorException

psyFileExists

static PsyBoolean psyFileExists(PsyString oFileName)
                         throws PsySecurityErrorException

Throws:

PsySecurityErrorException

psyIsFile

static PsyBoolean psyIsFile(PsyString oFileName)
                     throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyIsDirectory

static PsyBoolean psyIsDirectory(PsyString oFileName)
                          throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyIsSameFile

static PsyBoolean psyIsSameFile(PsyString oFileName1,
 PsyString oFileName2)
                         throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyIsSymlink

static PsyBoolean psyIsSymlink(PsyString oFileName)
                        throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyFileSize

static PsyInteger psyFileSize(PsyString oFileName)
                       throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Returns the integer representing the size (in bytes) for the file or directory with the given name.

Parameters:

oFileName - a string representing the file name.

Returns:

the integer representing the size (in bytes) for the file or directory with the given name

Throws:

PsyFileAccessDeniedException - when the operation is prohibited due to a file permission or other access check.

PsyFileNotFoundException - when the file or directory does not exist.

PsySecurityErrorException - when security policy is violated.

PsyIOErrorException - when an I/O error occurs.

psyFileAccessTime

static PsyInteger psyFileAccessTime(PsyString oFileName)
                             throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyFileCreationTime

static PsyInteger psyFileCreationTime(PsyString oFileName)
                               throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyFileModifiedTime

static PsyInteger psyFileModifiedTime(PsyString oFileName)
                               throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyCurrentDirectory

static PsyString psyCurrentDirectory()

Returns a string representing the absolute name of the current directory.

Returns:

a string representing the absolute name of the current directory

psyFileAbsolutePath

static PsyString psyFileAbsolutePath(PsyString oFileName)
                              throws PsyIOErrorException

Returns a string representing the absolute path to given file.

Parameters:

oFileName - a string representing file name.

Returns:

a string representing the absolute path to given file

Throws:

PsyIOErrorException - when an I/O error occurs.

psyFilePermissions

static PsyInteger psyFilePermissions(PsyString oFileName)
                              throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyChangeFilePermissions

static void psyChangeFilePermissions(PsyString oFileName,
 PsyInteger oPermissions)
                              throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

psyFileAttribute

static PsyObject psyFileAttribute(PsyString oFileName,
 PsyString oAttribute)
                           throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException,
PsyTypeCheckException,
PsyUndefinedException,
PsyUnsupportedException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

PsyTypeCheckException

PsyUndefinedException

PsyUnsupportedException

psyChangeFileAttribute

static void psyChangeFileAttribute(PsyString oFileName,
 PsyString oAttribute,
 PsyString oValue)
                            throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsySecurityErrorException,
PsyTypeCheckException,
PsyUndefinedException,
PsyUnsupportedException

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsySecurityErrorException

PsyTypeCheckException

PsyUndefinedException

PsyUnsupportedException

psyFiles

static PsyFormalStream<PsyString> psyFiles(PsyString oFileName)
                                    throws PsyFileAccessDeniedException,
PsyFileNotFoundException,
PsyIOErrorException,
PsyNotDirectoryException,
PsySecurityErrorException

Returns a lazily populated stream, the elements of which are the entries in the directory. The listing is not recursive.}

Parameters:

oFileName - the name of the directory.

Returns:

a lazily populated stream, the elements of which are the entries in the directory

Throws:

PsyIOErrorException - when an I/O error occurs.

PsyFileAccessDeniedException

PsyFileNotFoundException

PsyNotDirectoryException

PsySecurityErrorException