org.bridje.vfs

Class VFile

java.lang.Object

org.bridje.vfs.VFile

public class VFile
extends Object

Represents a file of the VFS tree.

Constructor Summary

Constructors

Constructor and Description
VFile(Path path) Constructor of this class.
VFile(String path) Another constructor of this class.

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Check if we can read on this node.
boolean	canWrite() Check if we can write on this node.
boolean	createNewFile() Create a new file.
boolean	delete() Delete a file in the VFS tree.
boolean	equals(Object obj)
boolean	exists() Check if the file exist really.
String	getMimeType() Return String object with the name of the file type, for example: For the case of the files .txt, this method return "text/plain"
String	getName() Call to getName method of Path class.
VFile	getParent() Return VFile object that represent the parent of the file in the VFS tree.
Path	getPath() Return the path representation of the path attribute
int	hashCode()
boolean	isDirectory() Check if the node is a directory
boolean	isFile() Check if the node is a file.
String[]	list() Return String Array with the names of files and folder that they exist in this path attribute.
VFile[]	listFiles() Return VFile Array with the names of files and folder that they exist in this path attribute.
boolean	mkdir() Create a new directory.
void	mount(VfsSource source) Mount a node(file or folder) on VFS tree. for example, Let's suppose that we want to mount the folder ("/etc/resources"), the call to the method: mount(new FileSource(new File("/etc/resources")))
VFile[]	search(GlobExpr globExpr) This method we utilized it when we want to search any file inside of the path for example: VFile[] files = file.search(new GlobExpr("*.txt")); this code return VFile[] with all files with txt extension, we can utilize in the quest any regular expression.
String	toString() Return String object, convert a path object to the String representation.
void	unmount() Unmount the las source mounted (if any) in this file off the VFS tree.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VFile

public VFile(Path path)

Constructor of this class.

Parameters:

path - The Path object that represent the file or folder.

VFile

public VFile(String path)

Another constructor of this class.

Parameters:

path - The string representation of the path (file or folder).

Method Detail

getName

public String getName()

Call to getName method of Path class.

Returns:

A String object that represents the first element of the path.

getPath

public Path getPath()

Return the path representation of the path attribute

Returns:

A Path object.

getParent

public VFile getParent()

Return VFile object that represent the parent of the file in the VFS tree.

For example, if the path represented by this object equals to "usr/local/somefile", this method will return a VFile object where the path attribute has value"usr/local".

Returns:

A VFile object, this is the parent of the file.

isDirectory

public boolean isDirectory()

Check if the node is a directory

Returns:

Boolean, true if the node is a directory and false otherwise.

exists

public boolean exists()

Check if the file exist really.

Returns:

Boolean, true if the file exist and false otherwise.

createNewFile

public boolean createNewFile()

Create a new file.

Returns:

Boolean, true if the file is created without problem and false otherwise.

delete

public boolean delete()

Delete a file in the VFS tree.

Returns:

Boolean, true if the file is deleted without problem and false otherwise.

mkdir

public boolean mkdir()

Create a new directory.

Returns:

Boolean, true if the directory is created without problem and false otherwise.

isFile

public boolean isFile()

Check if the node is a file.

Returns:

Boolean, true if the node is a file and false otherwise.

canWrite

public boolean canWrite()

Check if we can write on this node.

Returns:

Boolean, true if we can write and false otherwise.

canRead

public boolean canRead()

Check if we can read on this node.

Returns:

Boolean, true if we can read and false otherwise.

mount

public void mount(VfsSource source)
           throws FileNotFoundException

Mount a node(file or folder) on VFS tree. for example, Let's suppose that we want to mount the folder ("/etc/resources"), the call to the method: mount(new FileSource(new File("/etc/resources")))

Parameters:

source - VfsSource object

Throws:

FileNotFoundException - If the underlying file does not exists.

unmount

public void unmount()
             throws FileNotFoundException

Unmount the las source mounted (if any) in this file off the VFS tree.

Throws:

FileNotFoundException - If the underlying file does not exists.

list

public String[] list()

Return String Array with the names of files and folder that they exist in this path attribute.

Returns:

String[] ,String Array with the names of files and folder that they exist in this path attribute.

listFiles

public VFile[] listFiles()

Return VFile Array with the names of files and folder that they exist in this path attribute.

Returns:

VFile[] ,VFiles Array with the names of files and folder that they exist in this path attribute.

search

public VFile[] search(GlobExpr globExpr)

This method we utilized it when we want to search any file inside of the path for example: VFile[] files = file.search(new GlobExpr("*.txt")); this code return VFile[] with all files with txt extension, we can utilize in the quest any regular expression.

Parameters:

globExpr - The expression to filter the files.

Returns:

VFile[], return VFile Array that result of the quest.

getMimeType

public String getMimeType()

Return String object with the name of the file type, for example: For the case of the files .txt, this method return "text/plain"

Returns:

String object, return String object with name of the file type.

toString

public String toString()

Return String object, convert a path object to the String representation.

Overrides:

toString in class Object

Returns:

String object, return String object that represent el path of files that String.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object