Uses of Interface
org.apache.commons.vfs2.FileObject

Packages that use FileObject

Package	Description
org.apache.commons.vfs2	The public VFS API.
org.apache.commons.vfs2.cache	VFS File caching.
org.apache.commons.vfs2.events	VFS Events.
org.apache.commons.vfs2.filter	Implementations of FileFilter.
org.apache.commons.vfs2.impl	The standard VFS implementation.
org.apache.commons.vfs2.operations	VFS Operations handling.
org.apache.commons.vfs2.operations.vcs	VFS version control operations.
org.apache.commons.vfs2.provider	The File Provider API, and utility classes.
org.apache.commons.vfs2.provider.bzip2	The BZIP2 File Provider.
org.apache.commons.vfs2.provider.compressed	The compressed file provider.
org.apache.commons.vfs2.provider.ftp	The FTP File Provider.
org.apache.commons.vfs2.provider.gzip	The GZIP File Provider.
org.apache.commons.vfs2.provider.http	The HTTP File Provider.
org.apache.commons.vfs2.provider.http4	The HTTP4 File Provider.
org.apache.commons.vfs2.provider.http5	The HTTP5 File Provider.
org.apache.commons.vfs2.provider.jar	The Jar File Provider.
org.apache.commons.vfs2.provider.local	The Local File Provider.
org.apache.commons.vfs2.provider.ram	The RAM File Provider.
org.apache.commons.vfs2.provider.res	The Resource File Provider.
org.apache.commons.vfs2.provider.sftp	The SFTP Provider.
org.apache.commons.vfs2.provider.tar	The Tar File Provider.
org.apache.commons.vfs2.provider.temp	The Temporary Filespace Provider.
org.apache.commons.vfs2.provider.url	The Default File Provider, which wraps URL.
org.apache.commons.vfs2.provider.zip	The Zip File Provider.
org.apache.commons.vfs2.util	Utility classes used by the VFS.

Uses of FileObject in org.apache.commons.vfs2

Fields in org.apache.commons.vfs2 declared as FileObject

Modifier and Type	Field	Description
static final FileObject[]	FileObject.EMPTY_ARRAY	An empty immutable FileObject array.

Methods in org.apache.commons.vfs2 that return FileObject

Modifier and Type	Method	Description
FileObject	FileSystemManager.createFileSystem(String provider, FileObject file)	Creates a layered file system.
FileObject	FileSystemManager.createFileSystem(FileObject file)	Creates a layered file system.
FileObject	FileSystemManager.createVirtualFileSystem(String rootUri)	Creates an empty virtual file system.
FileObject	FileSystemManager.createVirtualFileSystem(FileObject rootFile)	Creates a virtual file system.
FileObject[]	FileObject.findFiles(FileSelector selector)	Finds the set of matching descendants of this file, in depthwise order.
FileObject	FileSystemManager.getBaseFile()	Returns the base file used to resolve relative paths.
FileObject	FileSelectInfo.getBaseFolder()	Gets the base folder of the traversal.
FileObject	FileObject.getChild(String name)	Gets a child of this file.
FileObject[]	FileObject.getChildren()	Gets a lists of children of this file.
FileObject	FileChangeEvent.getFile()	Deprecated. Use FileChangeEvent.getFileObject().
FileObject	FileContent.getFile()	Gets the file which this is the content of.
FileObject	FilesCache.getFile(FileSystem fileSystem, FileName fileName)	Retrieves a FileObject from the cache by name.
FileObject	FileSelectInfo.getFile()	Gets the file (or folder) to be considered.
FileObject	FileChangeEvent.getFileObject()	Returns the file that changed.
FileObject	FileObject.getParent()	Gets the folder that contains this file.
FileObject	FileSystem.getParentLayer()	Returns the parent layer if this is a layered file system.
FileObject	FileSystem.getRoot()	Returns the root file of this file system.
FileObject	FileObject.resolveFile(String path)	Finds a file, relative to this file.
FileObject	FileObject.resolveFile(String name, NameScope scope)	Finds a file relative to this file.
FileObject	FileSystem.resolveFile(String name)	Finds a file in this file system.
FileObject	FileSystem.resolveFile(FileName name)	Finds a file in this file system.
FileObject	FileSystemManager.resolveFile(File baseFile, String name)	Locates a file by name.
FileObject	FileSystemManager.resolveFile(String name)	Locates a file by name.
FileObject	FileSystemManager.resolveFile(String name, FileSystemOptions fileSystemOptions)	Locates a file by name.
FileObject	FileSystemManager.resolveFile(URI uri)	Resolves a URI into a FileObject.
FileObject	FileSystemManager.resolveFile(URL url)	Resolves a URL into a FileObject.
FileObject	FileSystemManager.resolveFile(FileObject baseFile, String name)	Locates a file by name.
FileObject	FileSystemManager.toFileObject(File file)	Converts a local file into a FileObject.
default FileObject	FileSystemManager.toFileObject(Path path)	Converts a local path into a FileObject.

Methods in org.apache.commons.vfs2 with parameters of type FileObject

Modifier and Type	Method	Description
void	FileMonitor.addFile(FileObject file)	Adds a file to be monitored.
void	FileSystem.addJunction(String junctionPoint, FileObject targetFile)	Adds a junction to this file system.
void	FileSystem.addListener(FileObject file, FileListener listener)	Adds a listener on a file in this file system.
boolean	FileSystemManager.canCreateFileSystem(FileObject file)	Determines if a layered file system can be created for a given file.
boolean	FileObject.canRenameTo(FileObject newfile)	Queries the file if it is possible to rename it to newfile.
static void	FileUtil.copyContent(FileObject srcFile, FileObject destFile)	Deprecated. Use FileObjectUtils.writeContent(FileObject, FileObject).
void	FileObject.copyFrom(FileObject srcFile, FileSelector selector)	Copies another file, and all its descendants, to this file.
FileObject	FileSystemManager.createFileSystem(String provider, FileObject file)	Creates a layered file system.
FileObject	FileSystemManager.createFileSystem(FileObject file)	Creates a layered file system.
FileObject	FileSystemManager.createVirtualFileSystem(FileObject rootFile)	Creates a virtual file system.
static byte[]	FileUtil.getContent(FileObject file)	Deprecated. Use FileObjectUtils.getContentAsByteArray(FileObject).
void	FileObject.moveTo(FileObject destFile)	Move this file.
void	FilesCache.putFile(FileObject file)	Adds a FileObject to the cache.
boolean	FilesCache.putFileIfAbsent(FileObject file)	Adds a FileObject to the cache if it isn't already present.
void	FileMonitor.removeFile(FileObject file)	Removes a file from being monitored.
void	FileSystem.removeListener(FileObject file, FileListener listener)	Removes a listener from a file in this file system.
File	FileSystem.replicateFile(FileObject file, FileSelector selector)	Creates a temporary local copy of a file and its descendants.
FileObject	FileSystemManager.resolveFile(FileObject baseFile, String name)	Locates a file by name.
long	FileContent.write(FileObject file)	Writes this content to another FileObject.
static void	FileUtil.writeContent(FileObject file, OutputStream output)	Deprecated. Use FileObjectUtils.writeContent(FileObject, OutputStream).

Method parameters in org.apache.commons.vfs2 with type arguments of type FileObject

Modifier and Type	Method	Description
void	FileObject.findFiles(FileSelector selector, boolean depthwise, List<FileObject> selected)	Finds the set of matching descendants of this file.

Constructors in org.apache.commons.vfs2 with parameters of type FileObject

Modifier	Constructor	Description
	FileChangeEvent(FileObject fileObject)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.cache

Classes in org.apache.commons.vfs2.cache that implement FileObject

Modifier and Type	Class	Description
class	OnCallRefreshFileObject	This decorator refreshes the fileObject data on every call.

Methods in org.apache.commons.vfs2.cache that return FileObject

Modifier and Type	Method	Description
FileObject[]	OnCallRefreshFileObject.findFiles(FileSelector selector)
FileObject	OnCallRefreshFileObject.getChild(String name)
FileObject[]	OnCallRefreshFileObject.getChildren()
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 fileName)
FileObject	OnCallRefreshFileObject.resolveFile(String path)
FileObject	OnCallRefreshFileObject.resolveFile(String name, NameScope scope)

Methods in org.apache.commons.vfs2.cache that return types with arguments of type FileObject

Modifier and Type	Method	Description
protected Reference<FileObject>	SoftRefFilesCache.createReference(FileObject file, ReferenceQueue<FileObject> referenceQueue)	Constructs a new Reference.
protected Reference<FileObject>	WeakRefFilesCache.createReference(FileObject file, ReferenceQueue<FileObject> refqueue)
protected ConcurrentMap<FileName,FileObject>	DefaultFilesCache.getOrCreateFilesystemCache(FileSystem fileSystem)	Gets or creates a Map.
protected Map<FileName,FileObject>	LRUFilesCache.getOrCreateFilesystemCache(FileSystem fileSystem)	Gets or creates a new Map.
protected Map<FileName,Reference<FileObject>>	SoftRefFilesCache.getOrCreateFilesystemCache(FileSystem fileSystem)	Gets or creates a new Map.

Methods in org.apache.commons.vfs2.cache with parameters of type FileObject

Modifier and Type	Method	Description
void	OnCallRefreshFileObject.copyFrom(FileObject srcFile, FileSelector selector)
protected Reference<FileObject>	SoftRefFilesCache.createReference(FileObject file, ReferenceQueue<FileObject> referenceQueue)	Constructs a new Reference.
protected Reference<FileObject>	WeakRefFilesCache.createReference(FileObject file, ReferenceQueue<FileObject> refqueue)
void	OnCallRefreshFileObject.moveTo(FileObject destFile)
void	DefaultFilesCache.putFile(FileObject file)
void	LRUFilesCache.putFile(FileObject file)
void	NullFilesCache.putFile(FileObject file)
void	SoftRefFilesCache.putFile(FileObject fileObject)
boolean	DefaultFilesCache.putFileIfAbsent(FileObject file)
boolean	LRUFilesCache.putFileIfAbsent(FileObject file)
boolean	NullFilesCache.putFileIfAbsent(FileObject file)
boolean	SoftRefFilesCache.putFileIfAbsent(FileObject fileObject)
void	AbstractFilesCache.touchFile(FileObject file)	Default implementation is a NOOP.
void	LRUFilesCache.touchFile(FileObject file)

Method parameters in org.apache.commons.vfs2.cache with type arguments of type FileObject

Modifier and Type	Method	Description
protected Reference<FileObject>	SoftRefFilesCache.createReference(FileObject file, ReferenceQueue<FileObject> referenceQueue)	Constructs a new Reference.
protected Reference<FileObject>	WeakRefFilesCache.createReference(FileObject file, ReferenceQueue<FileObject> refqueue)
void	OnCallRefreshFileObject.findFiles(FileSelector selector, boolean depthwise, List<FileObject> selected)

Constructors in org.apache.commons.vfs2.cache with parameters of type FileObject

Modifier	Constructor	Description
	OnCallRefreshFileObject(FileObject fileObject)	Constructs a new instance to decorate the given file object.

Uses of FileObject in org.apache.commons.vfs2.events

Constructors in org.apache.commons.vfs2.events with parameters of type FileObject

Modifier	Constructor	Description
	AbstractFileChangeEvent(FileObject fileObject)	Constructs a new instance for subclasses.
	ChangedEvent(FileObject fileObject)	Constructs a new instance.
	CreateEvent(FileObject fileObject)	Constructs a new instance.
	DeleteEvent(FileObject fileObject)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.filter

Constructors in org.apache.commons.vfs2.filter with parameters of type FileObject

Modifier	Constructor	Description
	AgeFileFilter(FileObject cutoffReference)	Constructs a new age file filter for files older than (at or before) a certain File (whose last modification time will be used as reference).
	AgeFileFilter(FileObject cutoffReference, boolean acceptOlder)	Constructs a new age file filter for files on any one side of a certain File (whose last modification time will be used as reference).

Uses of FileObject in org.apache.commons.vfs2.impl

Classes in org.apache.commons.vfs2.impl that implement FileObject

Modifier and Type	Class	Description
class	DecoratedFileObject	Base class to build a FileObject decoration.
class	SynchronizedFileObject	This decorator synchronizes all access to the FileObject.

Methods in org.apache.commons.vfs2.impl that return FileObject

Modifier and Type	Method	Description
protected FileObject	VirtualFileSystem.createFile(AbstractFileName name)	Creates a file object.
FileObject	DefaultFileSystemManager.createFileSystem(String scheme, FileObject file)	Creates a layered file system.
FileObject	DefaultFileSystemManager.createFileSystem(FileObject file)	Creates a layered file system.
FileObject	VirtualFileProvider.createFileSystem(String rootUri)	Creates an empty virtual file system.
FileObject	VirtualFileProvider.createFileSystem(FileObject rootFile)	Creates a virtual file system, with the supplied file as its root.
FileObject	DefaultFileSystemManager.createVirtualFileSystem(String rootUri)	Creates an empty virtual file system.
FileObject	DefaultFileSystemManager.createVirtualFileSystem(FileObject rootFile)	Creates a virtual file system.
FileObject[]	DecoratedFileObject.findFiles(FileSelector selector)
FileObject[]	SynchronizedFileObject.findFiles(FileSelector selector)
FileObject	DefaultFileSystemManager.getBaseFile()	Gets the base file used to resolve relative URI.
FileObject	DecoratedFileObject.getChild(String name)
FileObject	SynchronizedFileObject.getChild(String name)
FileObject[]	DecoratedFileObject.getChildren()
FileObject[]	SynchronizedFileObject.getChildren()
FileObject	DecoratedFileObject.getDecoratedFileObject()	Gets the decorated fileObject.
FileObject[]	VFSClassLoader.getFileObjects()	Provide access to the file objects this class loader represents.
FileObject	DecoratedFileObject.getParent()
FileObject	DecoratedFileObject.resolveFile(String path)
FileObject	DecoratedFileObject.resolveFile(String name, NameScope scope)
FileObject	DefaultFileSystemManager.resolveFile(File baseFile, String uri)	Resolves a URI, relative to base file.
FileObject	DefaultFileSystemManager.resolveFile(String uri)	Locates a file by URI.
FileObject	DefaultFileSystemManager.resolveFile(String uri, FileSystemOptions fileSystemOptions)	Resolves a file by URI, use the FileSystemOptions for file-system creation.
FileObject	DefaultFileSystemManager.resolveFile(URI uri)	Resolves a URI into a FileObject.
FileObject	DefaultFileSystemManager.resolveFile(URL url)	Resolves a URL into a FileObject.
FileObject	DefaultFileSystemManager.resolveFile(FileObject baseFile, String uri)	Resolves a URI, relative to a base file.
FileObject	DefaultFileSystemManager.resolveFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Resolves a URI, relative to a base file with specified FileSystem configuration.
FileObject	SynchronizedFileObject.resolveFile(String path)
FileObject	SynchronizedFileObject.resolveFile(String name, NameScope scope)
FileObject	DefaultFileSystemManager.toFileObject(File file)	Converts a local file into a FileObject.

Methods in org.apache.commons.vfs2.impl that return types with arguments of type FileObject

Modifier and Type	Method	Description
Iterator<FileObject>	DecoratedFileObject.iterator()

Methods in org.apache.commons.vfs2.impl with parameters of type FileObject

Modifier and Type	Method	Description
void	DefaultFileMonitor.addFile(FileObject file)	Adds a file to be monitored.
void	VirtualFileSystem.addJunction(String junctionPoint, FileObject targetFile)	Adds a junction to this file system.
boolean	DefaultFileSystemManager.canCreateFileSystem(FileObject file)	Tests if a layered file system can be created for a given file.
boolean	DecoratedFileObject.canRenameTo(FileObject newfile)
int	DecoratedFileObject.compareTo(FileObject fo)
void	DecoratedFileObject.copyFrom(FileObject srcFile, FileSelector selector)
void	SynchronizedFileObject.copyFrom(FileObject srcFile, FileSelector selector)
FileObject	DefaultFileSystemManager.createFileSystem(String scheme, FileObject file)	Creates a layered file system.
FileObject	DefaultFileSystemManager.createFileSystem(FileObject file)	Creates a layered file system.
FileObject	VirtualFileProvider.createFileSystem(FileObject rootFile)	Creates a virtual file system, with the supplied file as its root.
FileObject	DefaultFileSystemManager.createVirtualFileSystem(FileObject rootFile)	Creates a virtual file system.
void	DecoratedFileObject.moveTo(FileObject destFile)
void	SynchronizedFileObject.moveTo(FileObject destFile)
protected void	DefaultFileMonitor.queueAddFile(FileObject file)	Queues a file for addition to be monitored.
protected void	DefaultFileMonitor.queueRemoveFile(FileObject file)	Queues a file for removal from being monitored.
void	DefaultFileMonitor.removeFile(FileObject file)	Removes a file from being monitored.
File	DefaultFileReplicator.replicateFile(FileObject srcFile, FileSelector selector)	Creates a local copy of the file, and all its descendants.
File	PrivilegedFileReplicator.replicateFile(FileObject srcFile, FileSelector selector)	Creates a local copy of the file, and all its descendants.
FileObject	DefaultFileSystemManager.resolveFile(FileObject baseFile, String uri)	Resolves a URI, relative to a base file.
FileObject	DefaultFileSystemManager.resolveFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Resolves a URI, relative to a base file with specified FileSystem configuration.
void	DefaultFileSystemManager.setBaseFile(FileObject baseFile)	Sets the base file to use when resolving relative URI.

Method parameters in org.apache.commons.vfs2.impl with type arguments of type FileObject

Modifier and Type	Method	Description
void	DecoratedFileObject.findFiles(FileSelector selector, boolean depthwise, List<FileObject> selected)
void	SynchronizedFileObject.findFiles(FileSelector selector, boolean depthwise, List<FileObject> selected)

Constructors in org.apache.commons.vfs2.impl with parameters of type FileObject

Modifier	Constructor	Description
	DecoratedFileObject(FileObject fileObject)	Constructs a new instance to decorate the given FileObject.
	SynchronizedFileObject(FileObject fileObject)	Constructs a new instance.
	VFSClassLoader(FileObject[] files, FileSystemManager manager)	Constructors a new VFSClassLoader for the given files.
	VFSClassLoader(FileObject[] files, FileSystemManager manager, ClassLoader parent)	Constructors a new VFSClassLoader for the given FileObjects.
	VFSClassLoader(FileObject file, FileSystemManager manager)	Constructors a new VFSClassLoader for the given file.
	VFSClassLoader(FileObject file, FileSystemManager manager, ClassLoader parent)	Constructors a new VFSClassLoader for the given file.

Uses of FileObject in org.apache.commons.vfs2.operations

Methods in org.apache.commons.vfs2.operations that return FileObject

Modifier and Type	Method	Description
protected FileObject	AbstractFileOperation.getFileObject()	Gets the instance of FileObject for this FileOperation.

Methods in org.apache.commons.vfs2.operations with parameters of type FileObject

Modifier and Type	Method	Description
final void	AbstractFileOperationProvider.collectOperations(Collection<Class<? extends FileOperation>> operationsList, FileObject file)	Gather available operations for the specified FileObject and put them into specified operationsList.
void	FileOperationProvider.collectOperations(Collection<Class<? extends FileOperation>> operationsList, FileObject file)	Gather available operations for the specified FileObject and put them into specified operationsList.
protected abstract void	AbstractFileOperationProvider.doCollectOperations(Collection<Class<? extends FileOperation>> availableOperations, Collection<Class<? extends FileOperation>> resultList, FileObject file)	Gather available operations for the specified FileObject and put them into specified operationsList.
final FileOperation	AbstractFileOperationProvider.getOperation(FileObject file, Class<? extends FileOperation> operationClass)
FileOperation	FileOperationProvider.getOperation(FileObject file, Class<? extends FileOperation> operationClass)	Gets implementation for a given FileObject and FileOperation interface.
protected abstract FileOperation	AbstractFileOperationProvider.instantiateOperation(FileObject file, Class<? extends FileOperation> operationClass)	Gets operation instance for specified FileOperation subclass.

Constructors in org.apache.commons.vfs2.operations with parameters of type FileObject

Modifier	Constructor	Description
	AbstractFileOperation(FileObject file)	Constructs a new instance for subclasses.
	DefaultFileOperations(FileObject file)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.operations.vcs

Methods in org.apache.commons.vfs2.operations.vcs with parameters of type FileObject

Modifier and Type	Method	Description
void	VcsCheckout.setTargetDirectory(FileObject targetDir)	Sets directory under which retrieved files should be placed.

Uses of FileObject in org.apache.commons.vfs2.provider

Classes in org.apache.commons.vfs2.provider that implement FileObject

Modifier and Type	Class	Description
class	AbstractFileObject<AFS extends AbstractFileSystem>	A partial file object implementation.
class	DelegateFileObject<AFS extends AbstractFileSystem>	A file backed by another file.

Methods in org.apache.commons.vfs2.provider that return FileObject

Modifier and Type	Method	Description
protected abstract FileObject	AbstractFileSystem.createFile(AbstractFileName name)	Creates a file object.
FileObject	AbstractFileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
FileObject	AbstractLayeredFileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
FileObject	FileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
protected FileObject	AbstractFileSystem.decorateFileObject(FileObject file)	Decorates the given file object.
protected FileObject[]	AbstractFileObject.doListChildrenResolved()	Lists the children of this file.
FileObject	AbstractLayeredFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
protected FileObject	AbstractOriginatingFileProvider.findFile(FileName fileName, FileSystemOptions fileSystemOptions)	Locates a file from its parsed URI.
FileObject	AbstractOriginatingFileProvider.findFile(FileObject baseFileObject, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject	CompositeFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject	FileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject[]	AbstractFileObject.findFiles(FileSelector selector)	Finds the set of matching descendants of this file, in depthwise order.
FileObject	LocalFileProvider.findLocalFile(File file)	Converts from java.io.File to FileObject.
FileObject	LocalFileProvider.findLocalFile(String name)	Finds a local file, from its local name.
FileObject	AbstractFileObject.getChild(String name)	Returns a child of this file.
FileObject[]	AbstractFileObject.getChildren()	Returns the children of the file.
FileObject	DelegateFileObject.getDelegateFile()	Gets access to the delegated file.
FileObject	DefaultFileContent.getFile()	Returns the file that this is the content of.
protected FileObject	AbstractFileSystem.getFileFromCache(FileName name)	Gets a cached file.
FileObject	AbstractFileObject.getParent()	Returns the parent of the file.
FileObject	AbstractFileSystem.getParentLayer()	Gets the parent layer if this is a layered file system.
FileObject	AbstractFileSystem.getRoot()	Gets the root file of this file system.
FileObject	AbstractFileObject.resolveFile(String path)	Finds a file, relative to this file.
FileObject	AbstractFileObject.resolveFile(String name, NameScope scope)	Returns a child by name.
FileObject	AbstractFileSystem.resolveFile(String nameStr)	Finds a file in this file system.
FileObject	AbstractFileSystem.resolveFile(FileName name)	Finds a file in this file system.
FileObject	VfsComponentContext.resolveFile(String name, FileSystemOptions fileSystemOptions)	Resolves a file by name.
FileObject	VfsComponentContext.resolveFile(FileObject baseFile, String name, FileSystemOptions fileSystemOptions)	Resolves a file by name.
FileObject	VfsComponentContext.toFileObject(File file)	Returns a FileObject for a local file.

Methods in org.apache.commons.vfs2.provider that return types with arguments of type FileObject

Modifier and Type	Method	Description
Iterator<FileObject>	AbstractFileObject.iterator()	Returns an iterator over a set of all FileObject in this file object.
List<FileObject>	AbstractFileObject.listFiles(FileSelector selector)	Lists the set of matching descendants of this file, in depthwise order.

Methods in org.apache.commons.vfs2.provider with parameters of type FileObject

Modifier and Type	Method	Description
void	AbstractFileSystem.addJunction(String junctionPoint, FileObject targetFile)	Adds a junction to this file system.
void	AbstractFileSystem.addListener(FileObject file, FileListener listener)	Adds a listener on a file in this file system.
boolean	AbstractFileObject.canRenameTo(FileObject newfile)	Queries the object if a simple rename to the file name of newfile is possible.
int	AbstractFileObject.compareTo(FileObject file)	Compares two FileObjects (ignores case).
void	AbstractFileObject.copyFrom(FileObject file, FileSelector selector)	Copies another file to this file.
FileObject	AbstractFileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
FileObject	AbstractLayeredFileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
FileObject	FileProvider.createFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
protected FileObject	AbstractFileSystem.decorateFileObject(FileObject file)	Decorates the given file object.
protected abstract FileSystem	AbstractLayeredFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
protected boolean	AbstractFileObject.doIsSameFile(FileObject destFile)	Checks if this fileObject is the same file as destFile just with a different name.
protected void	AbstractFileObject.doRename(FileObject newFile)	Renames the file.
protected void	DelegateFileObject.doRename(FileObject newFile)	Renames the file.
protected File	AbstractFileSystem.doReplicateFile(FileObject file, FileSelector selector)	Creates a temporary local copy of a file and its descendants.
FileObject	AbstractLayeredFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject	AbstractOriginatingFileProvider.findFile(FileObject baseFileObject, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject	CompositeFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
FileObject	FileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
void	AbstractFileSystem.fireFileChanged(FileObject file)	Fires a file changed event.
void	AbstractFileSystem.fireFileCreated(FileObject file)	Fires a file create event.
void	AbstractFileSystem.fireFileDeleted(FileObject file)	Fires a file delete event.
protected boolean	AbstractFileObject.isSameFile(FileObject destFile)	Checks if this fileObject is the same file as destFile just with a different name.
void	AbstractFileObject.moveTo(FileObject destFile)	Moves (rename) the file to another one.
protected void	AbstractFileSystem.putFileToCache(FileObject file)	Adds a file object to the cache.
void	AbstractFileSystem.removeListener(FileObject file, FileListener listener)	Removes a listener from a file in this file system.
File	AbstractFileSystem.replicateFile(FileObject file, FileSelector selector)	Creates a temporary local copy of a file and its descendants.
File	FileReplicator.replicateFile(FileObject srcFile, FileSelector selector)	Creates a local copy of the file, and all its descendants.
FileObject	VfsComponentContext.resolveFile(FileObject baseFile, String name, FileSystemOptions fileSystemOptions)	Resolves a file by name.
void	DelegateFileObject.setFile(FileObject fileObject)	Attaches or detaches the target file.
long	DefaultFileContent.write(FileObject file)	Writes this content to another FileObject.

Method parameters in org.apache.commons.vfs2.provider with type arguments of type FileObject

Modifier and Type	Method	Description
void	AbstractFileObject.findFiles(FileSelector selector, boolean depthwise, List<FileObject> selected)	Traverses the descendants of this file, and builds a list of selected files.

Constructors in org.apache.commons.vfs2.provider with parameters of type FileObject

Modifier	Constructor	Description
protected	AbstractFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.
	DelegateFileObject(AbstractFileName fileName, AFS fileSystem, FileObject fileObject)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.provider.bzip2

Classes in org.apache.commons.vfs2.provider.bzip2 that implement FileObject

Modifier and Type	Class	Description
class	Bzip2FileObject	the bzip2 file.

Methods in org.apache.commons.vfs2.provider.bzip2 that return FileObject

Modifier and Type	Method	Description
protected FileObject	Bzip2FileSystem.createFile(AbstractFileName name)

Methods in org.apache.commons.vfs2.provider.bzip2 with parameters of type FileObject

Modifier and Type	Method	Description
protected FileSystem	Bzip2FileProvider.createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)

Constructors in org.apache.commons.vfs2.provider.bzip2 with parameters of type FileObject

Modifier	Constructor	Description
protected	Bzip2FileObject(AbstractFileName fileName, FileObject container, Bzip2FileSystem fileSystem)	Constructs a new instance.
protected	Bzip2FileObject(AbstractFileName name, FileObject container, CompressedFileFileSystem fs)	Deprecated. Use Bzip2FileObject(AbstractFileName, FileObject, Bzip2FileSystem) instead.
protected	Bzip2FileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.provider.compressed

Classes in org.apache.commons.vfs2.provider.compressed that implement FileObject

Modifier and Type	Class	Description
class	CompressedFileFileObject<FS extends CompressedFileFileSystem>	A compressed file.

Methods in org.apache.commons.vfs2.provider.compressed that return FileObject

Modifier and Type	Method	Description
protected abstract FileObject	CompressedFileFileSystem.createFile(AbstractFileName name)	Creates a file object.
protected FileObject	CompressedFileFileObject.getContainer()	Gets the container.

Methods in org.apache.commons.vfs2.provider.compressed with parameters of type FileObject

Modifier and Type	Method	Description
protected abstract FileSystem	CompressedFileFileProvider.createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)	Create a FileSystem.
protected FileSystem	CompressedFileFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.

Constructors in org.apache.commons.vfs2.provider.compressed with parameters of type FileObject

Modifier	Constructor	Description
protected	CompressedFileFileObject(AbstractFileName fileName, FileObject container, FS fileSystem)	Constructs a new instance.
protected	CompressedFileFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.provider.ftp

Classes in org.apache.commons.vfs2.provider.ftp that implement FileObject

Modifier and Type	Class	Description
class	FtpFileObject	An FTP file.

Methods in org.apache.commons.vfs2.provider.ftp that return FileObject

Modifier and Type	Method	Description
protected FileObject	FtpFileSystem.createFile(AbstractFileName name)	Creates a file object.
protected FileObject[]	FtpFileObject.doListChildrenResolved()
FileObject[]	FtpFileObject.getChildren()	Returns the file's list of children.

Methods in org.apache.commons.vfs2.provider.ftp with parameters of type FileObject

Modifier and Type	Method	Description
protected void	FtpFileObject.doRename(FileObject newFile)	Renames the file

Uses of FileObject in org.apache.commons.vfs2.provider.gzip

Classes in org.apache.commons.vfs2.provider.gzip that implement FileObject

Modifier and Type	Class	Description
class	GzipFileObject	A Gzip file.

Methods in org.apache.commons.vfs2.provider.gzip that return FileObject

Modifier and Type	Method	Description
protected FileObject	GzipFileSystem.createFile(AbstractFileName name)

Methods in org.apache.commons.vfs2.provider.gzip with parameters of type FileObject

Modifier and Type	Method	Description
protected FileSystem	GzipFileProvider.createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)

Constructors in org.apache.commons.vfs2.provider.gzip with parameters of type FileObject

Modifier	Constructor	Description
protected	GzipFileObject(AbstractFileName name, FileObject container, CompressedFileFileSystem fs)	Deprecated. Use GzipFileObject(AbstractFileName, FileObject, GzipFileSystem) instead.
protected	GzipFileObject(AbstractFileName fileName, FileObject container, GzipFileSystem fileSystem)	Constructs a new instance.
protected	GzipFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.provider.http

Classes in org.apache.commons.vfs2.provider.http that implement FileObject

Modifier and Type	Class	Description
class	HttpFileObject<FS extends HttpFileSystem>	Deprecated. Use org.apache.commons.vfs2.provider.http5.

Methods in org.apache.commons.vfs2.provider.http that return FileObject

Modifier and Type	Method	Description
protected FileObject	HttpFileSystem.createFile(AbstractFileName name)	Deprecated. Creates a file object.

Uses of FileObject in org.apache.commons.vfs2.provider.http4

Classes in org.apache.commons.vfs2.provider.http4 that implement FileObject

Modifier and Type	Class	Description
class	Http4FileObject<FS extends Http4FileSystem>	Deprecated. Use org.apache.commons.vfs2.provider.http5.

Methods in org.apache.commons.vfs2.provider.http4 that return FileObject

Modifier and Type	Method	Description
protected FileObject	Http4FileSystem.createFile(AbstractFileName name)	Deprecated.

Uses of FileObject in org.apache.commons.vfs2.provider.http5

Classes in org.apache.commons.vfs2.provider.http5 that implement FileObject

Modifier and Type	Class	Description
class	Http5FileObject<FS extends Http5FileSystem>	A file object backed by Apache HttpComponents HttpClient v5.

Methods in org.apache.commons.vfs2.provider.http5 that return FileObject

Modifier and Type	Method	Description
protected FileObject	Http5FileSystem.createFile(AbstractFileName name)

Uses of FileObject in org.apache.commons.vfs2.provider.jar

Classes in org.apache.commons.vfs2.provider.jar that implement FileObject

Modifier and Type	Class	Description
class	JarFileObject	A file in a Jar file system.

Methods in org.apache.commons.vfs2.provider.jar with parameters of type FileObject

Modifier and Type	Method	Description
protected FileSystem	JarFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.

Constructors in org.apache.commons.vfs2.provider.jar with parameters of type FileObject

Modifier	Constructor	Description
protected	JarFileSystem(AbstractFileName rootFileName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.provider.local

Classes in org.apache.commons.vfs2.provider.local that implement FileObject

Modifier and Type	Class	Description
class	LocalFile	A file object implementation which uses direct file access.

Methods in org.apache.commons.vfs2.provider.local that return FileObject

Modifier and Type	Method	Description
protected FileObject	LocalFileSystem.createFile(AbstractFileName name)	Creates a file object.
FileObject	DefaultLocalFileProvider.findLocalFile(File file)	Finds a local file.
FileObject	DefaultLocalFileProvider.findLocalFile(String name)	Finds a local file, from its local name.

Methods in org.apache.commons.vfs2.provider.local with parameters of type FileObject

Modifier and Type	Method	Description
protected boolean	LocalFile.doIsSameFile(FileObject destFile)
protected void	LocalFile.doRename(FileObject newFile)	rename this file
protected File	LocalFileSystem.doReplicateFile(FileObject fileObject, FileSelector selector)	Creates a temporary local copy of a file and its descendants.

Uses of FileObject in org.apache.commons.vfs2.provider.ram

Classes in org.apache.commons.vfs2.provider.ram that implement FileObject

Modifier and Type	Class	Description
class	RamFileObject	A RAM File contains a single RAM FileData instance, it provides methods to access the data by implementing FileObject interface.

Methods in org.apache.commons.vfs2.provider.ram that return FileObject

Modifier and Type	Method	Description
protected FileObject	RamFileSystem.createFile(AbstractFileName name)

Methods in org.apache.commons.vfs2.provider.ram with parameters of type FileObject

Modifier and Type	Method	Description
protected void	RamFileObject.doRename(FileObject newFile)

Uses of FileObject in org.apache.commons.vfs2.provider.res

Methods in org.apache.commons.vfs2.provider.res that return FileObject

Modifier and Type	Method	Description
FileObject	ResourceFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.

Methods in org.apache.commons.vfs2.provider.res with parameters of type FileObject

Modifier and Type	Method	Description
FileObject	ResourceFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.

Uses of FileObject in org.apache.commons.vfs2.provider.sftp

Classes in org.apache.commons.vfs2.provider.sftp that implement FileObject

Modifier and Type	Class	Description
class	SftpFileObject	An SFTP file.

Methods in org.apache.commons.vfs2.provider.sftp that return FileObject

Modifier and Type	Method	Description
protected FileObject	SftpFileSystem.createFile(AbstractFileName name)	Creates a file object.
protected FileObject[]	SftpFileObject.doListChildrenResolved()	Lists the children of this file.

Methods in org.apache.commons.vfs2.provider.sftp with parameters of type FileObject

Modifier and Type	Method	Description
protected void	SftpFileObject.doRename(FileObject newFile)	Renames the file.

Uses of FileObject in org.apache.commons.vfs2.provider.tar

Classes in org.apache.commons.vfs2.provider.tar that implement FileObject

Modifier and Type	Class	Description
class	TarFileObject	A file in a Tar file system.

Methods in org.apache.commons.vfs2.provider.tar that return FileObject

Modifier and Type	Method	Description
protected FileObject	TarFileSystem.createFile(AbstractFileName name)	Creates a file object.
protected FileObject	TarFileSystem.getFileFromCache(FileName name)	Returns a cached file.

Methods in org.apache.commons.vfs2.provider.tar with parameters of type FileObject

Modifier and Type	Method	Description
protected FileSystem	TarFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
protected void	TarFileSystem.putFileToCache(FileObject file)	Adds a file object to the cache.

Constructors in org.apache.commons.vfs2.provider.tar with parameters of type FileObject

Modifier	Constructor	Description
protected	TarFileSystem(AbstractFileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.provider.temp

Methods in org.apache.commons.vfs2.provider.temp that return FileObject

Modifier and Type	Method	Description
FileObject	TemporaryFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.

Methods in org.apache.commons.vfs2.provider.temp with parameters of type FileObject

Modifier and Type	Method	Description
FileObject	TemporaryFileProvider.findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.

Uses of FileObject in org.apache.commons.vfs2.provider.url

Classes in org.apache.commons.vfs2.provider.url that implement FileObject

Modifier and Type	Class	Description
class	UrlFileObject	A FileObject implementation backed by a URL.

Methods in org.apache.commons.vfs2.provider.url that return FileObject

Modifier and Type	Method	Description
protected FileObject	UrlFileSystem.createFile(AbstractFileName name)	Creates a file object.
FileObject	UrlFileProvider.findFile(FileObject baseFile, String fileUri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.

Methods in org.apache.commons.vfs2.provider.url with parameters of type FileObject

Modifier and Type	Method	Description
FileObject	UrlFileProvider.findFile(FileObject baseFile, String fileUri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.

Uses of FileObject in org.apache.commons.vfs2.provider.zip

Classes in org.apache.commons.vfs2.provider.zip that implement FileObject

Modifier and Type	Class	Description
class	ZipFileObject	A file in a ZIP file system.

Methods in org.apache.commons.vfs2.provider.zip that return FileObject

Modifier and Type	Method	Description
protected FileObject	ZipFileSystem.createFile(AbstractFileName name)	Creates a file object.
protected FileObject	ZipFileSystem.getFileFromCache(FileName name)	Gets a cached file.

Methods in org.apache.commons.vfs2.provider.zip with parameters of type FileObject

Modifier and Type	Method	Description
protected FileSystem	ZipFileProvider.doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
protected void	ZipFileSystem.putFileToCache(FileObject file)	Adds a file object to the cache.

Constructors in org.apache.commons.vfs2.provider.zip with parameters of type FileObject

Modifier	Constructor	Description
	ZipFileSystem(AbstractFileName rootFileName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Uses of FileObject in org.apache.commons.vfs2.util

Methods in org.apache.commons.vfs2.util with parameters of type FileObject

Modifier and Type	Method	Description
static boolean	FileObjectUtils.exists(FileObject fileObject)	Null-safe call to exists().
static AbstractFileObject	FileObjectUtils.getAbstractFileObject(FileObject fileObject)	Gets access to the base object even if decorated.
static byte[]	FileObjectUtils.getContentAsByteArray(FileObject file)	Gets the content of a file object, as a byte array.
static String	FileObjectUtils.getContentAsString(FileObject file, String charset)	Returns the content of a file as a String.
static String	FileObjectUtils.getContentAsString(FileObject file, Charset charset)	Gets the content of a file as a String.
static void	WeakRefFileListener.installListener(FileObject file, FileListener listener)	Install the listener at the given file.
static boolean	FileObjectUtils.isInstanceOf(FileObject fileObject, Class<?> wantedClass)	Checks if the given FileObject is instance of given class argument.
static Properties	FileObjectUtils.readProperties(FileObject fileObject)	Reads the given file into a new Properties.
static Properties	FileObjectUtils.readProperties(FileObject fileObject, Properties properties)	Reads the given file into a new given Properties.
static void	FileObjectUtils.writeContent(FileObject file, OutputStream output)	Writes the content of a file to an OutputStream.
static void	FileObjectUtils.writeContent(FileObject srcFile, FileObject destFile)	Writes the content from a source file to a destination file.

Constructors in org.apache.commons.vfs2.util with parameters of type FileObject

Modifier	Constructor	Description
protected	WeakRefFileListener(FileObject file, FileListener listener)	Constructs a new instance.