org.bridje.vfs

Interface VfsService

public interface VfsService

This interface represents the virtual file system for Bridje, it provides methods to mount and file files and folder into the system.

Method Summary

Modifier and Type	Method and Description
boolean	canRead(Path path) Check if we can read on this node.
boolean	canWrite(Path path) Check if we can write on this node.
boolean	createNewFile(Path path) Create a new file.
boolean	delete(Path path) Delete a file in the VFS tree.
boolean	exists(Path path) Check if the file exist really.
String	getMimeType(String extension) Return String object with the name of the file type.
boolean	isDirectory(Path path) Check if the node is a directory
boolean	isFile(Path path) Check if the node is a file.
String[]	list(Path path) Return String Array with the names of files and folder that they exist in this path attribute.
boolean	mkdir(Path path) Create a new directory.
void	mount(Path path, VfsSource source) Mounts a new source into the given path.
InputStream	openForRead(Path path) Return InputStream object, then we can read the files.
OutputStream	openForWrite(Path path) Return OutputStream object, then we can write the file.
VFile[]	search(GlobExpr globExpr, Path path) This method we utilized it when we want to search any file inside of the path
void	unmount(Path path) Unmounts the last source mounted into the given path.

Method Detail

mount

void mount(Path path,
           VfsSource source)
    throws FileNotFoundException

Mounts a new source into the given path.

Parameters:

path - The path to mount the source.

source - The virtual file system source object to be mounted.

Throws:

FileNotFoundException - If the underlying file does not exists.

unmount

void unmount(Path path)
      throws FileNotFoundException

Unmounts the last source mounted into the given path.

Parameters:

path - The path to mount the source.

Throws:

FileNotFoundException - If the underlying file does not exists.

isDirectory

boolean isDirectory(Path path)

Check if the node is a directory

Parameters:

path - The path attribute

Returns:

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

exists

boolean exists(Path path)

Check if the file exist really.

Parameters:

path - The path attribute

Returns:

Boolean, true if the file exist and false otherwise.

isFile

boolean isFile(Path path)

Check if the node is a file.

Parameters:

path - The path attribute

Returns:

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

canWrite

boolean canWrite(Path path)

Check if we can write on this node.

Parameters:

path - The path attribute

Returns:

Boolean, true if we can write and false otherwise.

canRead

boolean canRead(Path path)

Check if we can read on this node.

Parameters:

path - The path attribute

Returns:

Boolean, true if we can read and false otherwise.

list

String[] list(Path path)

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

Parameters:

path - The path attribute

Returns:

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

openForRead

InputStream openForRead(Path path)

Return InputStream object, then we can read the files. This method we utilized it when we want to read a file

Parameters:

path - The path attribute

Returns:

InputStream object.

openForWrite

OutputStream openForWrite(Path path)

Return OutputStream object, then we can write the file. This method we utilized it when we want to write a file

Parameters:

path - The path attribute

Returns:

OutputStream object.

search

VFile[] search(GlobExpr globExpr,
               Path path)

This method we utilized it when we want to search any file inside of the path

Parameters:

globExpr - object, that represent the regular expression for make the quest.

path - The path attribute

Returns:

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

createNewFile

boolean createNewFile(Path path)

Create a new file.

Parameters:

path - The path attribute

Returns:

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

delete

boolean delete(Path path)

Delete a file in the VFS tree.

Parameters:

path - The path attribute

Returns:

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

mkdir

boolean mkdir(Path path)

Create a new directory.

Parameters:

path - The path attribute

Returns:

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

getMimeType

String getMimeType(String extension)

Return String object with the name of the file type.

Parameters:

extension - The extension of the file.

Returns:

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