Interface VirtualFileSystem

All Known Subinterfaces:

ListFS, MountableFS

All Known Implementing Classes:

AbstractDelegateVirtualFileSystem, AbstractVirtualFileSystem, DefaultMountableVFS, DetachedVirtualFileSystem, EmptyVFS, FileACLVirtualFileSystem, FilteredFileSystem, FolderVFS, NativeVFS, SubVFS, VFolderVFS

public interface VirtualFileSystem

Author:

taha.bensalah@gmail.com

Method Summary

Modifier and Type	Method	Description
void	copyFrom(String path, File file)
void	copyTo(String path, File file)
void	copyTo(String path, VFile file)
void	copyTo(String inFile, VFile outFile, VFileFilter filter)
File	copyToNativeTempFile(String path)
VFile	createTempFile(String prefix, String suffix, String folder)
void	delete(String path)
void	deleteAll(String path)
boolean	exists(String path)
VirtualFileSystem	filter(VFileFilter fileFilter)
VirtualFileSystem	filter(VFileFilter fileFilter, String fsId)
VFile	get(String path)
VFile	get(String parent, String path)
VirtualFileACL	getACL(String path)	return ACL information on the given file or null if the file does could not be resolved Though null value should not be check against existence of the file/folder
VFile	getBase(String path, String vfsId)
VFileType	getFileType(String path)
String	getId()
InputStream	getInputStream(String path)
OutputStream	getOutputStream(String path)
OutputStream	getOutputStream(String path, boolean append)
VFile	getParentFile(String path)
VFile[]	getRoots()
VFSSecurityManager	getSecurityManager()
boolean	isDirectory(String path)
boolean	isFile(String path)
boolean	isParentOf(String parent, String child)
long	lastModified(String path)
long	length(String path)
VFile[]	listFiles(String path)
VFile[]	listFiles(String path, VFileFilter fileFilter)
boolean	mkdir(String path)
boolean	mkdirs(String path)
String	probeContentType(String path, boolean bestEffort)
byte[]	readBytes(String path)
void	renameTo(String path, VFile file)
VirtualFileSystem	subfs(String path)	creates a sub fs with random generated fsId
VirtualFileSystem	subfs(String path, String fsId)
void	write(String path, InputStream stream)
void	writeBytes(String path, byte[] bytes)

Method Details

getId

String getId()

get

VFile get(String parent,
 String path)

get

VFile get(String path)

getBase

VFile getBase(String path,
 String vfsId)

lastModified

long lastModified(String path)

length

long length(String path)

getParentFile

VFile getParentFile(String path)

exists

boolean exists(String path)

getInputStream

InputStream getInputStream(String path)
                    throws IOException

Throws:

IOException

getOutputStream

OutputStream getOutputStream(String path)
                      throws IOException

Throws:

IOException

getOutputStream

OutputStream getOutputStream(String path,
 boolean append)
                      throws IOException

Throws:

IOException

mkdir

boolean mkdir(String path)

mkdirs

boolean mkdirs(String path)

write

void write(String path,
 InputStream stream)
    throws IOException

Throws:

IOException

listFiles

VFile[] listFiles(String path)

listFiles

VFile[] listFiles(String path,
 VFileFilter fileFilter)

getRoots

VFile[] getRoots()

isFile

boolean isFile(String path)

getFileType

VFileType getFileType(String path)

isDirectory

boolean isDirectory(String path)

createTempFile

VFile createTempFile(String prefix,
 String suffix,
 String folder)

delete

void delete(String path)
     throws IOException

Throws:

IOException

deleteAll

void deleteAll(String path)
        throws IOException

Throws:

IOException

renameTo

void renameTo(String path,
 VFile file)
       throws IOException

Throws:

IOException

copyTo

void copyTo(String path,
 VFile file)
     throws IOException

Throws:

IOException

copyTo

void copyTo(String path,
 File file)
     throws IOException

Throws:

IOException

copyFrom

void copyFrom(String path,
 File file)
       throws IOException

Throws:

IOException

copyTo

void copyTo(String inFile,
 VFile outFile,
 VFileFilter filter)
     throws IOException

Throws:

IOException

isParentOf

boolean isParentOf(String parent,
 String child)

subfs

VirtualFileSystem subfs(String path)

creates a sub fs with random generated fsId

Parameters:

path -

Returns:

subfs

VirtualFileSystem subfs(String path,
 String fsId)

filter

VirtualFileSystem filter(VFileFilter fileFilter)

filter

VirtualFileSystem filter(VFileFilter fileFilter,
 String fsId)

readBytes

byte[] readBytes(String path)
          throws IOException

Throws:

IOException

writeBytes

void writeBytes(String path,
 byte[] bytes)
         throws IOException

Throws:

IOException

probeContentType

String probeContentType(String path,
 boolean bestEffort)
                 throws IOException

Throws:

IOException

getSecurityManager

VFSSecurityManager getSecurityManager()

getACL

VirtualFileACL getACL(String path)

return ACL information on the given file or null if the file does could not be resolved Though null value should not be check against existence of the file/folder

Parameters:

path - path to get ACL for

Returns:

ACL object for the given path

copyToNativeTempFile

File copyToNativeTempFile(String path)
                   throws IOException

Throws:

IOException