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

Packages that use FileName

Package	Description
org.apache.commons.vfs2	The public VFS API.
org.apache.commons.vfs2.cache	VFS File caching.
org.apache.commons.vfs2.impl	The standard VFS implementation.
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.ftps	The FTPS 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.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.url	The Default File Provider, which wraps URL.
org.apache.commons.vfs2.provider.zip	The Zip File Provider.

Uses of FileName in org.apache.commons.vfs2

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

Modifier and Type	Field	Description
static final FileName[]	FileName.EMPTY_ARRAY	Empty array of FileName.

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

Modifier and Type	Method	Description
FileName	FileObject.getName()	Gets the name of this file.
FileName	FileName.getParent()	Gets the file name of the parent of this file.
FileName	FileName.getRoot()	Gets the root of the file system.
FileName	FileSystem.getRootName()	Returns the name of the root file of this file system.
FileName	FileSystemManager.resolveName(FileName root, String name)	Resolves a name, relative to this file name.
FileName	FileSystemManager.resolveName(FileName root, String name, NameScope scope)	Resolves a name, relative to the "root" file name.
FileName	FileSystemManager.resolveURI(String uri)	Resolves the URI to a file name.

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

Modifier and Type	Method	Description
FileObject	FilesCache.getFile(FileSystem fileSystem, FileName fileName)	Retrieves a FileObject from the cache by name.
String	FileName.getRelativeName(FileName name)	Converts a file name to a relative name, relative to this file name.
boolean	FileName.isAncestor(FileName ancestor)	Tests if another file name is an ancestor of this file name.
boolean	FileName.isDescendent(FileName descendent)	Tests if another file name is a descendent of this file name.
boolean	FileName.isDescendent(FileName descendent, NameScope nameScope)	Tests 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, String name)	Resolves a name, relative to this file name.
FileName	FileSystemManager.resolveName(FileName root, String name, NameScope scope)	Resolves a name, relative to the "root" file name.

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

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

Modifier and Type	Method	Description
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 FileName

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 fileName)
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 fileName)

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

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

Modifier and Type	Class	Description
class	VirtualFileName	A simple file name to hold the scheme for to be created virtual file system.

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

Modifier and Type	Method	Description
FileName	VirtualFileName.createName(String absolutePath, FileType type)
FileName	DecoratedFileObject.getName()
FileName	DefaultFileSystemManager.resolveName(FileName root, String path)	Resolves a name, relative to the file.
FileName	DefaultFileSystemManager.resolveName(FileName base, String name, NameScope scope)	Resolves a name, relative to the root.
FileName	DefaultFileSystemManager.resolveURI(String uri)	Resolve the uri to a file name.

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

Modifier and Type	Method	Description
FileName	DefaultFileSystemManager.resolveName(FileName root, String path)	Resolves a name, relative to the file.
FileName	DefaultFileSystemManager.resolveName(FileName base, String name, NameScope scope)	Resolves a name, relative to the root.

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

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

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	GenericURLFileName	Generic file name that represents a URL.
class	LayeredFileName	A file name for layered files.
class	URLFileName	Deprecated. Use GenericURLFileName as it doesn't depend on HTTP Client v3 API directly.

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

Modifier and Type	Method	Description
abstract FileName	AbstractFileName.createName(String absolutePath, FileType fileType)	Factory method for creating name instances.
FileName	GenericFileName.createName(String absPath, FileType type)	Create a FileName.
FileName	GenericURLFileName.createName(String absPath, FileType type)	Creates a FileName.
FileName	LayeredFileName.createName(String path, FileType type)	Creates a FileName.
FileName	URLFileName.createName(String absPath, FileType type)	Deprecated. Create a FileName.
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 file system.
FileName	AbstractFileSystem.getRootName()	Gets the name of the root of this file system.
FileName	AbstractFileProvider.parseUri(FileName base, String uri)	Parses an absolute URI.
FileName	FileNameParser.parseUri(VfsComponentContext context, FileName base, String uri)	Parses a String into a file name.
FileName	FileProvider.parseUri(FileName root, String uri)	Parses the URI into a FileName.
FileName	GenericURLFileNameParser.parseUri(VfsComponentContext context, FileName base, String fileName)
FileName	HostFileNameParser.parseUri(VfsComponentContext context, FileName base, String fileName)
FileName	LayeredFileNameParser.parseUri(VfsComponentContext context, FileName baseFileName, String fileName)	Parses the base and name into a FileName.
FileName	URLFileNameParser.parseUri(VfsComponentContext context, FileName base, String fileName)	Deprecated.
FileName	VfsComponentContext.parseURI(String uri)	Parses a URI into a FileName.

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

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.
int	AbstractFileName.compareTo(FileName obj)	Implement Comparable.
protected abstract FileSystem	AbstractOriginatingFileProvider.doCreateFileSystem(FileName rootFileName, FileSystemOptions fileSystemOptions)	Creates a FileSystem.
protected FileObject	AbstractOriginatingFileProvider.findFile(FileName fileName, FileSystemOptions fileSystemOptions)	Locates a file from its parsed URI.
protected FileObject	AbstractFileSystem.getFileFromCache(FileName name)	Gets a cached file.
protected FileSystem	AbstractOriginatingFileProvider.getFileSystem(FileName rootFileName, FileSystemOptions fileSystemOptions)	Returns the FileSystem associated with the specified root.
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, String uri)	Parses an absolute URI.
FileName	FileNameParser.parseUri(VfsComponentContext context, FileName base, String uri)	Parses a String into a file name.
FileName	FileProvider.parseUri(FileName root, String uri)	Parses the URI into a FileName.
FileName	GenericURLFileNameParser.parseUri(VfsComponentContext context, FileName base, String fileName)
FileName	HostFileNameParser.parseUri(VfsComponentContext context, FileName base, String fileName)
FileName	LayeredFileNameParser.parseUri(VfsComponentContext context, FileName baseFileName, String fileName)	Parses the base and name into a FileName.
FileName	URLFileNameParser.parseUri(VfsComponentContext context, FileName base, String fileName)	Deprecated.
protected void	AbstractFileSystem.removeFileFromCache(FileName name)	Removes a cached file.
FileObject	AbstractFileSystem.resolveFile(FileName name)	Finds a file in this file system.

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

Modifier	Constructor	Description
protected	AbstractFileSystem(FileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.
	LayeredFileName(String scheme, FileName outerUri, String path, FileType type)	Constructs a new instance.

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

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

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 FileName

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

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

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

Modifier and Type	Method	Description
protected abstract FileSystem	CompressedFileFileProvider.createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)	Create a FileSystem.

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

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

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

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

Modifier and Type	Method	Description
protected FileSystem	FtpFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates the file system.
protected void	FtpFileObject.onChildrenChanged(FileName child, FileType newType)	Called when the children of this file change.

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

Modifier	Constructor	Description
protected	FtpFileObject(AbstractFileName fileName, FtpFileSystem fileSystem, FileName rootName)	Constructs a new instance.

Uses of FileName in org.apache.commons.vfs2.provider.ftps

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

Modifier and Type	Method	Description
protected FileSystem	FtpsFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates the file system.

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

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

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 FileName

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

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

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

Modifier and Type	Method	Description
protected FileSystem	HttpFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Deprecated. Creates a FileSystem.

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

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

Modifier and Type	Method	Description
protected FileSystem	Http4FileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Deprecated.

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

Modifier	Constructor	Description
protected	Http4FileSystem(FileName rootName, FileSystemOptions fileSystemOptions, org.apache.http.client.HttpClient httpClient, org.apache.http.client.protocol.HttpClientContext httpClientContext)	Deprecated. Constructs a new instance.

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

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

Modifier and Type	Method	Description
protected FileSystem	Http5FileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)

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

Modifier	Constructor	Description
protected	Http5FileSystem(FileName rootName, FileSystemOptions fileSystemOptions, org.apache.hc.client5.http.classic.HttpClient httpClient, org.apache.hc.client5.http.protocol.HttpClientContext httpClientContext)	Constructs Http4FileSystem.

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

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

Modifier and Type	Class	Description
class	LocalFileName	A local file URI.
class	WindowsFileName	A local file URI.

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

Modifier and Type	Method	Description
protected FileName	GenericFileNameParser.createFileName(String scheme, String rootFile, String path, FileType type)
protected abstract FileName	LocalFileNameParser.createFileName(String scheme, String rootFile, String path, FileType fileType)	Creates a FileName.
protected FileName	WindowsFileNameParser.createFileName(String scheme, String rootFile, String path, FileType type)
FileName	LocalFileName.createName(String path, FileType type)	Factory method for creating name instances.
FileName	WindowsFileName.createName(String path, FileType type)	Factory method for creating name instances.
FileName	LocalFileNameParser.parseUri(VfsComponentContext context, FileName base, String uri)

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

Modifier and Type	Method	Description
protected FileSystem	DefaultLocalFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates the file system.
FileName	LocalFileNameParser.parseUri(VfsComponentContext context, FileName base, String uri)

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

Modifier	Constructor	Description
	LocalFileSystem(FileName rootFileName, String rootFile, FileSystemOptions fileSystemOptions)	Constructs a new instance.

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

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

Modifier and Type	Method	Description
protected FileSystem	RamFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)

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

Modifier	Constructor	Description
protected	RamFileSystem(FileName rootName, FileSystemOptions fileSystemOptions)	Constructs a new instance.

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

Classes in org.apache.commons.vfs2.provider.res that implement FileName

Modifier and Type	Class	Description
class	ResourceFileName	A resource file URI.

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

Modifier and Type	Method	Description
protected FileName	ResourceFileNameParser.createFileName(String scheme, String rootFile, String path, FileType type)
FileName	ResourceFileName.createName(String path, FileType type)	Factory method for creating name instances.

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

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

Modifier and Type	Method	Description
protected FileSystem	SftpFileProvider.doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates a FileSystem.

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

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

Modifier and Type	Method	Description
protected void	TarFileObject.attachChild(FileName childName)	Attaches a child.
protected FileObject	TarFileSystem.getFileFromCache(FileName name)	Returns a cached file.
protected void	TarFileSystem.removeFileFromCache(FileName name)	remove a cached file.

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

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

Modifier and Type	Class	Description
class	UrlFileName	A URL FileName.

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

Modifier and Type	Method	Description
FileName	UrlFileNameParser.parseUri(VfsComponentContext context, FileName base, String uri)	Parse a URI.

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

Modifier and Type	Method	Description
protected URL	UrlFileObject.createURL(FileName name)	Creates a URL from the given file name.
protected boolean	UrlFileNameParser.isUrlBased(FileName base, String fileName)	Guess if the given file name is a URL with host or not.
FileName	UrlFileNameParser.parseUri(VfsComponentContext context, FileName base, String uri)	Parse a URI.

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

Modifier	Constructor	Description
protected	UrlFileSystem(FileName rootName, FileSystemOptions fileSystemOptions)	Constructs a new instance.

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

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

Modifier and Type	Method	Description
void	ZipFileObject.attachChild(FileName childName)	Attaches a child.
protected FileObject	ZipFileSystem.getFileFromCache(FileName name)	Gets a cached file.
protected void	ZipFileSystem.removeFileFromCache(FileName name)	remove a cached file.