FileSource (Bridje VFS 0.5.0-beta1 API)

java.lang.Object
- org.bridje.vfs.FileSource

All Implemented Interfaces:

VfsSource
```
public class FileSource
extends Object
implements VfsSource
```
This object represents a real file system source fot the virtual file system tree.

Constructor Summary

Constructors
Constructor and Description

FileSource(File file)
Default contructor for this object.

Constructors
Constructor and Description
`FileSource(File file)` Default contructor for this object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canRead(Path path)` Check if we can read on this VfsSource.
`boolean`	`canWrite(Path path)` Check if we can write on this VfsSource.
`boolean`	`createNewFile(Path path)` Create a new file.
`boolean`	`delete(Path path)` Delete a file.
`boolean`	`exists(Path path)` Check if the VfsSource exist really.
`boolean`	`isDirectory(Path path)` Check if the VfsSource is a directory
`boolean`	`isFile(Path path)` Check if the VfsSource 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.
`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.
`void`	`search(GlobExpr globExpr, File pathFile, Path path, List<Path> files)` Search for all the files that match the globExpr provided.
`List<Path>`	`search(GlobExpr globExpr, Path path)` This method we utilized it when we want to search any file inside of the path

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileSource
```
public FileSource(File file)
           throws IOException
```
    Default contructor for this object.
    
    Parameters:
    
    file - The file for this VFS source object.
    
    Throws:
    
    IOException - If any IO occurs.
- Method Detail
  - isDirectory
```
public boolean isDirectory(Path path)
```
    Description copied from interface: VfsSource
    
    Check if the VfsSource is a directory
    
    Specified by:
    
    isDirectory in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if the VfsSource is a directory and false otherwise.
  - isFile
```
public boolean isFile(Path path)
```
    Description copied from interface: VfsSource
    
    Check if the VfsSource is a file.
    
    Specified by:
    
    isFile in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if the VfsSource is a file and false otherwise.
  - exists
```
public boolean exists(Path path)
```
    Description copied from interface: VfsSource
    
    Check if the VfsSource exist really.
    
    Specified by:
    
    exists in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if the VfsSource exist and false otherwise.
  - canWrite
```
public boolean canWrite(Path path)
```
    Description copied from interface: VfsSource
    
    Check if we can write on this VfsSource.
    
    Specified by:
    
    canWrite in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if we can write and false otherwise.
  - canRead
```
public boolean canRead(Path path)
```
    Description copied from interface: VfsSource
    
    Check if we can read on this VfsSource.
    
    Specified by:
    
    canRead in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if we can read and false otherwise.
  - list
```
public String[] list(Path path)
```
    Description copied from interface: VfsSource
    
    Return String Array with the names of files and folder that they exist in this path attribute.
    
    Specified by:
    
    list in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    String[] ,String Array with the names of files and folder that they exist in this path attribute.
  - openForRead
```
public InputStream openForRead(Path path)
```
    Description copied from interface: VfsSource
    
    Return InputStream object, then we can read the files. This method we utilized it when we want to read a file
    
    Specified by:
    
    openForRead in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    InputStream object.
  - openForWrite
```
public OutputStream openForWrite(Path path)
```
    Description copied from interface: VfsSource
    
    Return OutputStream object, then we can write the file. This method we utilized it when we want to write a file
    
    Specified by:
    
    openForWrite in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    OutputStream object.
  - search
```
public List<Path> search(GlobExpr globExpr,
                         Path path)
```
    Description copied from interface: VfsSource
    
    This method we utilized it when we want to search any file inside of the path
    
    Specified by:
    
    search in interface VfsSource
    
    Parameters:
    
    globExpr - object, that represent the regular expression for make the quest.
    
    path - The path attribute
    
    Returns:
    
    List of Path, return List of Path object that result of the quest.
  - search
```
public void search(GlobExpr globExpr,
                   File pathFile,
                   Path path,
                   List<Path> files)
```
    Search for all the files that match the globExpr provided.
    
    Parameters:
    
    globExpr - The glob expr provided.
    
    pathFile - The path under witch the search must start.
    
    path - The path that needs to prefix all paths resulting from this search.
    
    files - The resulting paths for the search.
  - createNewFile
```
public boolean createNewFile(Path path)
```
    Description copied from interface: VfsSource
    
    Create a new file.
    
    Specified by:
    
    createNewFile in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if the file is created without problem and false otherwise.
  - mkdir
```
public boolean mkdir(Path path)
```
    Description copied from interface: VfsSource
    
    Create a new directory.
    
    Specified by:
    
    mkdir in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if the directory is created without problem and false otherwise.
  - delete
```
public boolean delete(Path path)
```
    Description copied from interface: VfsSource
    
    Delete a file.
    
    Specified by:
    
    delete in interface VfsSource
    
    Parameters:
    
    path - The path attribute
    
    Returns:
    
    Boolean, true if the file is deleted without problem and false otherwise.

Class FileSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileSource

Method Detail

isDirectory

isFile

exists

canWrite

canRead

list

openForRead

openForWrite

search

search

createNewFile

mkdir

delete