Package | Description |
---|---|
org.apache.commons.vfs |
The public VFS API.
|
org.apache.commons.vfs.cache | |
org.apache.commons.vfs.impl |
The standard VFS implementation.
|
org.apache.commons.vfs.provider |
The File Provider API, and utility classes.
|
org.apache.commons.vfs.provider.bzip2 | |
org.apache.commons.vfs.provider.compressed | |
org.apache.commons.vfs.provider.ftp |
The FTP File Provider.
|
org.apache.commons.vfs.provider.gzip | |
org.apache.commons.vfs.provider.http | |
org.apache.commons.vfs.provider.jar |
The Jar File Provider.
|
org.apache.commons.vfs.provider.local |
The Local File Provider.
|
org.apache.commons.vfs.provider.ram |
The RAM File Provider.
|
org.apache.commons.vfs.provider.sftp |
The SFTP Provider.
|
org.apache.commons.vfs.provider.tar |
The Tar File Provider.
|
org.apache.commons.vfs.provider.url |
The Default File Provider, which wraps java.net.URL.
|
org.apache.commons.vfs.provider.zip |
The Zip File Provider.
|
Modifier and Type | Method | Description |
---|---|---|
FileName |
FileObject.getName() |
Returns the name of this file.
|
FileName |
FileName.getParent() |
Returns the file name of the parent of this file.
|
FileName |
FileName.getRoot() |
find the root of the filesystem
|
FileName |
FileSystem.getRootName() |
Returns the name of the root file of this file system.
|
FileName |
FileSystemManager.resolveName(FileName root,
java.lang.String name) |
Resolves a name, relative to this file name.
|
FileName |
FileSystemManager.resolveName(FileName root,
java.lang.String name,
NameScope scope) |
Resolves a name, relative to the "root" file name.
|
FileName |
FileSystemManager.resolveURI(java.lang.String uri) |
Resolve the uri to a filename
|
Modifier and Type | Method | Description |
---|---|---|
FileObject |
FilesCache.getFile(FileSystem filesystem,
FileName name) |
retrieve a file from the cache by its name
|
java.lang.String |
FileName.getRelativeName(FileName name) |
Converts a file name to a relative name, relative to this file name.
|
boolean |
FileName.isAncestor(FileName ancestor) |
Determines if another file name is an ancestor of this file name.
|
boolean |
FileName.isDescendent(FileName descendent) |
Determines if another file name is a descendent of this file name.
|
boolean |
FileName.isDescendent(FileName descendent,
NameScope nameScope) |
Determines if another file name is a descendent of this file name.
|
void |
FilesCache.removeFile(FileSystem filesystem,
FileName name) |
removes a file from cache
|
FileObject |
FileSystem.resolveFile(FileName name) |
Finds a file in this file system.
|
FileName |
FileSystemManager.resolveName(FileName root,
java.lang.String name) |
Resolves a name, relative to this file name.
|
FileName |
FileSystemManager.resolveName(FileName root,
java.lang.String name,
NameScope scope) |
Resolves a name, relative to the "root" file name.
|
Modifier and Type | Method | Description |
---|---|---|
FileObject |
DefaultFilesCache.getFile(FileSystem filesystem,
FileName name) |
|
FileObject |
LRUFilesCache.getFile(FileSystem filesystem,
FileName name) |
|
FileObject |
NullFilesCache.getFile(FileSystem filesystem,
FileName name) |
|
FileObject |
SoftRefFilesCache.getFile(FileSystem filesystem,
FileName name) |
|
void |
DefaultFilesCache.removeFile(FileSystem filesystem,
FileName name) |
|
void |
LRUFilesCache.removeFile(FileSystem filesystem,
FileName name) |
|
void |
NullFilesCache.removeFile(FileSystem filesystem,
FileName name) |
|
void |
SoftRefFilesCache.removeFile(FileSystem filesystem,
FileName name) |
Modifier and Type | Class | Description |
---|---|---|
class |
VirtualFileName |
A simple Filename to hold the scheme for to be created virtual filesytsem.
|
Modifier and Type | Method | Description |
---|---|---|
FileName |
VirtualFileName.createName(java.lang.String absPath,
FileType type) |
|
FileName |
DecoratedFileObject.getName() |
|
FileName |
DefaultFileSystemManager.resolveName(FileName root,
java.lang.String path) |
Resolves a name, relative to the file.
|
FileName |
DefaultFileSystemManager.resolveName(FileName base,
java.lang.String name,
NameScope scope) |
Resolves a name, relative to the root.
|
FileName |
DefaultFileSystemManager.resolveURI(java.lang.String uri) |
resolve the uri to a filename
|
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
VirtualFileSystem.createFile(FileName name) |
Creates a file object.
|
FileName |
DefaultFileSystemManager.resolveName(FileName root,
java.lang.String path) |
Resolves a name, relative to the file.
|
FileName |
DefaultFileSystemManager.resolveName(FileName base,
java.lang.String name,
NameScope scope) |
Resolves a name, relative to the root.
|
Constructor | Description |
---|---|
VirtualFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Class | Description |
---|---|---|
class |
AbstractFileName |
A default file name implementation.
|
class |
GenericFileName |
A file name that represents a 'generic' URI, as per RFC 2396.
|
class |
LayeredFileName |
A file name for layered files.
|
class |
URLFileName |
Modifier and Type | Method | Description |
---|---|---|
abstract FileName |
AbstractFileName.createName(java.lang.String absPath,
FileType type) |
Factory method for creating name instances.
|
FileName |
GenericFileName.createName(java.lang.String absPath,
FileType type) |
|
FileName |
LayeredFileName.createName(java.lang.String path,
FileType type) |
|
FileName |
URLFileName.createName(java.lang.String absPath,
FileType type) |
|
FileName |
AbstractFileObject.getName() |
Returns the name of the file.
|
FileName |
LayeredFileName.getOuterName() |
Returns the URI of the outer file.
|
FileName |
AbstractFileName.getParent() |
Returns the name of the parent of the file.
|
FileName |
AbstractFileName.getRoot() |
find the root of the filesystem
|
FileName |
AbstractFileSystem.getRootName() |
Returns the name of the root of this file system.
|
FileName |
AbstractFileProvider.parseUri(FileName base,
java.lang.String uri) |
Parses an absolute URI.
|
FileName |
FileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
parses a String into a filename
|
FileName |
FileProvider.parseUri(FileName root,
java.lang.String uri) |
|
FileName |
HostFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
|
FileName |
LayeredFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
|
FileName |
URLFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
|
FileName |
VfsComponentContext.parseURI(java.lang.String uri) |
Modifier and Type | Method | Description |
---|---|---|
void |
DelegateFileObject.attachChild(FileName baseName,
FileType type) |
Adds a child to this file.
|
protected void |
AbstractFileObject.childrenChanged(FileName childName,
FileType newType) |
Notifies the file that its children have changed.
|
protected abstract FileObject |
AbstractFileSystem.createFile(FileName name) |
Creates a file object.
|
protected abstract FileSystem |
AbstractOriginatingFileProvider.doCreateFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions) |
Creates a
FileSystem . |
protected FileObject |
AbstractOriginatingFileProvider.findFile(FileName name,
FileSystemOptions fileSystemOptions) |
Locates a file from its parsed URI.
|
protected FileObject |
AbstractFileSystem.getFileFromCache(FileName name) |
Returns a cached file.
|
java.lang.String |
AbstractFileName.getRelativeName(FileName name) |
Converts a file name to a relative name, relative to this file name.
|
boolean |
AbstractFileName.isAncestor(FileName ancestor) |
Determines if another file name is an ancestor of this file name.
|
boolean |
AbstractFileName.isDescendent(FileName descendent) |
Determines if another file name is a descendent of this file name.
|
boolean |
AbstractFileName.isDescendent(FileName descendent,
NameScope scope) |
Determines if another file name is a descendent of this file name.
|
protected void |
AbstractFileObject.onChildrenChanged(FileName child,
FileType newType) |
Called when the children of this file change.
|
FileName |
AbstractFileProvider.parseUri(FileName base,
java.lang.String uri) |
Parses an absolute URI.
|
FileName |
FileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
parses a String into a filename
|
FileName |
FileProvider.parseUri(FileName root,
java.lang.String uri) |
|
FileName |
HostFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
|
FileName |
LayeredFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
|
FileName |
URLFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
|
protected void |
AbstractFileSystem.removeFileFromCache(FileName name) |
remove a cached file.
|
FileObject |
AbstractFileSystem.resolveFile(FileName name) |
Finds a file in this file system.
|
Constructor | Description |
---|---|
AbstractFileObject(FileName name,
AbstractFileSystem fs) |
|
AbstractFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
|
DelegateFileObject(FileName name,
AbstractFileSystem fileSystem,
FileObject file) |
|
LayeredFileName(java.lang.String scheme,
FileName outerUri,
java.lang.String path,
FileType type) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
Bzip2FileSystem.createFile(FileName name) |
|
protected FileSystem |
Bzip2FileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
Constructor | Description |
---|---|
Bzip2FileObject(FileName name,
FileObject container,
CompressedFileFileSystem fs) |
|
Bzip2FileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method | Description |
---|---|---|
protected abstract FileObject |
CompressedFileFileSystem.createFile(FileName name) |
Creates a file object.
|
protected abstract FileSystem |
CompressedFileFileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
Constructor | Description |
---|---|
CompressedFileFileObject(FileName name,
FileObject container,
CompressedFileFileSystem fs) |
|
CompressedFileFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
FtpFileSystem.createFile(FileName name) |
Creates a file object.
|
protected FileSystem |
FtpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions) |
Creates the filesystem.
|
protected void |
FtpFileObject.onChildrenChanged(FileName child,
FileType newType) |
Called when the children of this file change.
|
Constructor | Description |
---|---|
FtpFileObject(FileName name,
FtpFileSystem fileSystem,
FileName rootName) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
GzipFileSystem.createFile(FileName name) |
|
protected FileSystem |
GzipFileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
Constructor | Description |
---|---|
GzipFileObject(FileName name,
FileObject container,
CompressedFileFileSystem fs) |
|
GzipFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
HttpFileSystem.createFile(FileName name) |
Creates a file object.
|
protected FileSystem |
HttpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions) |
Creates a
FileSystem . |
Constructor | Description |
---|---|
HttpFileObject(FileName name,
HttpFileSystem fileSystem) |
Modifier and Type | Method | Description |
---|---|---|
protected ZipFileObject |
JarFileSystem.createZipFileObject(FileName name,
java.util.zip.ZipEntry entry) |
Constructor | Description |
---|---|
JarFileObject(FileName name,
java.util.zip.ZipEntry entry,
JarFileSystem fs,
boolean zipExists) |
|
JarFileSystem(FileName rootName,
FileObject file,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Class | Description |
---|---|---|
class |
LocalFileName |
A local file URI.
|
class |
WindowsFileName |
A local file URI.
|
Modifier and Type | Method | Description |
---|---|---|
protected FileName |
GenericFileNameParser.createFileName(java.lang.String scheme,
java.lang.String rootFile,
java.lang.String path,
FileType type) |
|
protected abstract FileName |
LocalFileNameParser.createFileName(java.lang.String scheme,
java.lang.String rootFile,
java.lang.String path,
FileType type) |
|
protected FileName |
WindowsFileNameParser.createFileName(java.lang.String scheme,
java.lang.String rootFile,
java.lang.String path,
FileType type) |
|
FileName |
LocalFileName.createName(java.lang.String path,
FileType type) |
Factory method for creating name instances.
|
FileName |
WindowsFileName.createName(java.lang.String path,
FileType type) |
Factory method for creating name instances.
|
FileName |
LocalFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
LocalFileSystem.createFile(FileName name) |
Creates a file object.
|
protected FileSystem |
DefaultLocalFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions) |
Creates the filesystem.
|
FileName |
LocalFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
Constructor | Description |
---|---|
LocalFile(LocalFileSystem fileSystem,
java.lang.String rootFile,
FileName name) |
Creates a non-root file.
|
LocalFileSystem(FileName rootName,
java.lang.String rootFile,
FileSystemOptions opts) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
RamFileSystem.createFile(FileName name) |
|
protected FileSystem |
RamFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions) |
Constructor | Description |
---|---|
RamFileObject(FileName name,
RamFileSystem fs) |
|
RamFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
SftpFileSystem.createFile(FileName name) |
Creates a file object.
|
protected FileSystem |
SftpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions) |
Creates a
FileSystem . |
Constructor | Description |
---|---|
SftpFileObject(FileName name,
SftpFileSystem fileSystem) |
Modifier and Type | Method | Description |
---|---|---|
protected void |
TarFileObject.attachChild(FileName childName) |
Attaches a child
|
protected FileObject |
TarFileSystem.createFile(FileName name) |
Creates a file object.
|
protected TarFileObject |
TarFileSystem.createTarFileObject(FileName name,
org.apache.commons.vfs.provider.tar.TarEntry entry) |
Constructor | Description |
---|---|
TarFileObject(FileName name,
org.apache.commons.vfs.provider.tar.TarEntry entry,
TarFileSystem fs,
boolean tarExists) |
|
TarFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Class | Description |
---|---|---|
class |
UrlFileName |
Created by IntelliJ IDEA.
|
Modifier and Type | Method | Description |
---|---|---|
FileName |
UrlFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
Modifier and Type | Method | Description |
---|---|---|
protected FileObject |
UrlFileSystem.createFile(FileName name) |
Creates a file object.
|
protected java.net.URL |
UrlFileObject.createURL(FileName name) |
|
protected boolean |
UrlFileNameParser.isUrlBased(FileName base,
java.lang.String filename) |
Guess is the given filename is a url with host or not.
|
FileName |
UrlFileNameParser.parseUri(VfsComponentContext context,
FileName base,
java.lang.String filename) |
Constructor | Description |
---|---|
UrlFileObject(UrlFileSystem fs,
FileName fileName) |
|
UrlFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method | Description |
---|---|---|
void |
ZipFileObject.attachChild(FileName childName) |
Attaches a child
|
protected FileObject |
ZipFileSystem.createFile(FileName name) |
Creates a file object.
|
protected ZipFileObject |
ZipFileSystem.createZipFileObject(FileName name,
java.util.zip.ZipEntry entry) |
Constructor | Description |
---|---|
ZipFileObject(FileName name,
java.util.zip.ZipEntry entry,
ZipFileSystem fs,
boolean zipExists) |
|
ZipFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |