Modifier and Type | Class and Description |
---|---|
class |
FileNotFolderException
Delivers a file-not-folder exception which happens when trying to issue
FileObject.getChildren() on a file. |
class |
FileNotFoundException
delivers a file-not-found exception.
|
class |
FileTypeHasNoContentException
delivers a file-not-folder exception which happens when trying to issue
FileObject.getChildren() on a file. |
Modifier and Type | Method and Description |
---|---|
void |
FileSystem.addJunction(String junctionPoint,
FileObject targetFile)
Adds a junction to this file system.
|
void |
FileSystemManager.addOperationProvider(String[] schemes,
FileOperationProvider operationProvider) |
void |
FileSystemManager.addOperationProvider(String scheme,
FileOperationProvider operationProvider)
Adds the specified FileOperationProvider for the specified scheme.
|
boolean |
FileSystemManager.canCreateFileSystem(FileObject file)
Determines if a layered file system can be created for a given file.
|
void |
FileObject.close()
Closes this file, and its content.
|
void |
FileContent.close()
Closes all resources used by the content, including any open stream.
|
void |
FileObject.copyFrom(FileObject srcFile,
FileSelector selector)
Copies another file, and all its descendents, to this file.
|
FileContentInfo |
FileContentInfoFactory.create(FileContent fileContent) |
void |
FileObject.createFile()
Creates this file, if it does not exist.
|
FileObject |
FileSystemManager.createFileSystem(FileObject file)
Creates a layered file system.
|
FileObject |
FileSystemManager.createFileSystem(String provider,
FileObject file)
Creates a layered file system.
|
void |
FileObject.createFolder()
Creates this folder, if it does not exist.
|
FileObject |
FileSystemManager.createVirtualFileSystem(FileObject rootFile)
Creates a virtual file system.
|
FileObject |
FileSystemManager.createVirtualFileSystem(String rootUri)
Creates an empty virtual file system.
|
boolean |
FileObject.delete()
Deletes this file.
|
int |
FileObject.delete(FileSelector selector)
Deletes all descendents of this file that match a selector.
|
boolean |
FileObject.exists()
Determines if this file exists.
|
FileObject[] |
FileObject.findFiles(FileSelector selector)
Finds the set of matching descendents of this file, in depthwise order.
|
void |
FileObject.findFiles(FileSelector selector,
boolean depthwise,
List<FileObject> selected)
Finds the set of matching descendents of this file.
|
Object |
FileSystem.getAttribute(String attrName)
Gets the value of an attribute of the file system.
|
Object |
FileContent.getAttribute(String attrName)
Gets the value of an attribute of the file's content.
|
String[] |
FileContent.getAttributeNames()
Lists the attributes of the file's content.
|
Map<String,Object> |
FileContent.getAttributes()
Returns a read-only map of this file's attributes.
|
FileObject |
FileSystemManager.getBaseFile()
Returns the base file used to resolve relative paths.
|
Certificate[] |
FileContent.getCertificates()
Retrieves the certificates if any used to sign this file or folder.
|
FileObject |
FileObject.getChild(String name)
Returns a child of this file.
|
FileObject[] |
FileObject.getChildren()
Lists the children of this file.
|
FileContent |
FileObject.getContent()
Returns this file's content.
|
FileContentInfo |
FileContent.getContentInfo()
get the content info.
|
FileOperations |
FileObject.getFileOperations() |
FileSystemConfigBuilder |
FileSystemManager.getFileSystemConfigBuilder(String scheme)
Get the configuration builder for the given scheme.
|
InputStream |
FileContent.getInputStream()
Returns an input stream for reading the file's content.
|
long |
FileContent.getLastModifiedTime()
Determines the last-modified timestamp of the file.
|
static FileSystemManager |
VFS.getManager()
Returns the default
FileSystemManager instance. |
FileOperationProvider[] |
FileSystemManager.getOperationProviders(String scheme) |
OutputStream |
FileContent.getOutputStream()
Returns an output stream for writing the file's content.
|
OutputStream |
FileContent.getOutputStream(boolean bAppend)
Returns an output stream for writing the file's content.
|
FileObject |
FileObject.getParent()
Returns the folder that contains this file.
|
FileObject |
FileSystem.getParentLayer()
Returns the parent layer if this is a layered file system.
|
String |
FileName.getPathDecoded()
Returns the absolute path of this file, within its file system.
|
Collection<Capability> |
FileSystemManager.getProviderCapabilities(String scheme)
Get the capabilities for a given scheme.
|
RandomAccessContent |
FileContent.getRandomAccessContent(RandomAccessMode mode)
Returns an stream for reading/writing the file's content.
|
String |
FileName.getRelativeName(FileName name)
Converts a file name to a relative name, relative to this file name.
|
FileObject |
FileSystem.getRoot()
Returns the root file of this file system.
|
long |
FileContent.getSize()
Determines the size of the file, in bytes.
|
FileType |
FileObject.getType()
Returns this file's type.
|
URL |
FileObject.getURL()
Returns a URL representing this file.
|
boolean |
FileContent.hasAttribute(String attrName)
Checks if an attribute of the file's content exists.
|
boolean |
FileTypeSelector.includeFile(FileSelectInfo fileInfo)
Determines if a file or folder should be selected.
|
boolean |
FileObject.isHidden()
Determines if this file is hidden.
|
boolean |
FileObject.isReadable()
Determines if this file can be read.
|
boolean |
FileObject.isWriteable()
Determines if this file can be written to.
|
void |
FileObject.moveTo(FileObject destFile)
Move this file.
|
void |
FileObject.refresh()
This will prepare the fileObject to get resynchronized with the underlaying filesystem if required.
|
void |
FileContent.removeAttribute(String attrName)
Removes the value of an attribute of the file's content.
|
void |
FileSystem.removeJunction(String junctionPoint)
Removes a junction from this file system.
|
File |
FileSystem.replicateFile(FileObject file,
FileSelector selector)
Creates a temporary local copy of a file and its descendents.
|
FileObject |
FileSystem.resolveFile(FileName name)
Finds a file in this file system.
|
FileObject |
FileSystemManager.resolveFile(FileObject baseFile,
String name)
ยง
Locates a file by name.
|
FileObject |
FileSystemManager.resolveFile(File baseFile,
String name)
Locates a file by name.
|
FileObject |
FileSystem.resolveFile(String name)
Finds a file in this file system.
|
FileObject |
FileObject.resolveFile(String path)
Finds a file, relative to this file.
|
FileObject |
FileSystemManager.resolveFile(String name)
Locates a file by name.
|
FileObject |
FileSystemManager.resolveFile(String name,
FileSystemOptions fileSystemOptions)
Locates a file by name.
|
FileObject |
FileObject.resolveFile(String name,
NameScope scope)
Finds a file, relative to this file.
|
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)
Resolve the uri to a filename.
|
void |
FileSystem.setAttribute(String attrName,
Object value)
Sets the value of an attribute of the file's content.
|
void |
FileContent.setAttribute(String attrName,
Object value)
Sets the value of an attribute of the file's content.
|
void |
FileContent.setLastModifiedTime(long modTime)
Sets the last-modified timestamp of the file.
|
FileObject |
FileSystemManager.toFileObject(File file)
Converts a local file into a
FileObject . |
Modifier and Type | Method and Description |
---|---|
void |
OnCallRefreshFileObject.close() |
void |
OnCallRefreshFileObject.copyFrom(FileObject srcFile,
FileSelector selector) |
void |
OnCallRefreshFileObject.createFile() |
void |
OnCallRefreshFileObject.createFolder() |
boolean |
OnCallRefreshFileObject.delete() |
int |
OnCallRefreshFileObject.delete(FileSelector selector) |
boolean |
OnCallRefreshFileObject.exists() |
FileObject[] |
OnCallRefreshFileObject.findFiles(FileSelector selector) |
void |
OnCallRefreshFileObject.findFiles(FileSelector selector,
boolean depthwise,
List<FileObject> selected) |
FileObject |
OnCallRefreshFileObject.getChild(String name) |
FileObject[] |
OnCallRefreshFileObject.getChildren() |
FileContent |
OnCallRefreshFileObject.getContent() |
FileType |
OnCallRefreshFileObject.getType() |
boolean |
OnCallRefreshFileObject.isHidden() |
boolean |
OnCallRefreshFileObject.isReadable() |
boolean |
OnCallRefreshFileObject.isWriteable() |
void |
OnCallRefreshFileObject.moveTo(FileObject destFile) |
FileObject |
OnCallRefreshFileObject.resolveFile(String path) |
FileObject |
OnCallRefreshFileObject.resolveFile(String name,
NameScope scope) |
Modifier and Type | Method and Description |
---|---|
void |
VirtualFileSystem.addJunction(String junctionPoint,
FileObject targetFile)
Adds a junction to this file system.
|
void |
DefaultFileSystemManager.addOperationProvider(String[] schemes,
FileOperationProvider operationProvider) |
void |
DefaultFileSystemManager.addOperationProvider(String scheme,
FileOperationProvider operationProvider)
Adds the specified FileOperationProvider for the specified scheme.
|
void |
DefaultFileSystemManager.addProvider(String[] urlSchemes,
FileProvider provider)
Registers a file system provider.
|
void |
DefaultFileSystemManager.addProvider(String urlScheme,
FileProvider provider)
Registers a file system provider.
|
File |
DefaultFileReplicator.allocateFile(String baseName)
Allocates a new temporary file.
|
boolean |
DefaultFileSystemManager.canCreateFileSystem(FileObject file)
Determines if a layered file system can be created for a given file.
|
void |
SynchronizedFileObject.close() |
void |
DecoratedFileObject.close() |
protected void |
StandardFileSystemManager.configurePlugins()
Scans the classpath to find any droped plugin.
The plugin-description has to be in /META-INF/vfs-providers.xml |
void |
SynchronizedFileObject.copyFrom(FileObject srcFile,
FileSelector selector) |
void |
DecoratedFileObject.copyFrom(FileObject srcFile,
FileSelector selector) |
protected File |
DefaultFileReplicator.createAndAddFile(File parent,
String basename) |
void |
SynchronizedFileObject.createFile() |
void |
DecoratedFileObject.createFile() |
protected File |
DefaultFileReplicator.createFile(File parent,
String name)
create the temporary file
|
FileObject |
VirtualFileProvider.createFileSystem(FileObject rootFile)
Creates a virtual file system, with the supplied file as its root.
|
FileObject |
DefaultFileSystemManager.createFileSystem(FileObject file)
Creates a layered file system.
|
FileObject |
VirtualFileProvider.createFileSystem(String rootUri)
Creates an empty virtual file system.
|
FileObject |
DefaultFileSystemManager.createFileSystem(String scheme,
FileObject file)
Creates a layered file system.
|
void |
SynchronizedFileObject.createFolder() |
void |
DecoratedFileObject.createFolder() |
FileObject |
DefaultFileSystemManager.createVirtualFileSystem(FileObject rootFile)
Creates a virtual file system.
|
FileObject |
DefaultFileSystemManager.createVirtualFileSystem(String rootUri)
Creates an empty virtual file system.
|
boolean |
SynchronizedFileObject.delete() |
boolean |
DecoratedFileObject.delete() |
int |
SynchronizedFileObject.delete(FileSelector selector) |
int |
DecoratedFileObject.delete(FileSelector selector) |
boolean |
SynchronizedFileObject.exists() |
boolean |
DecoratedFileObject.exists() |
FileObject[] |
SynchronizedFileObject.findFiles(FileSelector selector) |
FileObject[] |
DecoratedFileObject.findFiles(FileSelector selector) |
void |
SynchronizedFileObject.findFiles(FileSelector selector,
boolean depthwise,
List<FileObject> selected) |
void |
DecoratedFileObject.findFiles(FileSelector selector,
boolean depthwise,
List<FileObject> selected) |
FileObject |
DefaultFileSystemManager.getBaseFile()
Returns the base file used to resolve relative URI.
|
FileObject |
SynchronizedFileObject.getChild(String name) |
FileObject |
DecoratedFileObject.getChild(String name) |
FileObject[] |
SynchronizedFileObject.getChildren() |
FileObject[] |
DecoratedFileObject.getChildren() |
FileContent |
SynchronizedFileObject.getContent() |
FileContent |
DecoratedFileObject.getContent() |
FileOperations |
DecoratedFileObject.getFileOperations() |
FileSystemConfigBuilder |
DefaultFileSystemManager.getFileSystemConfigBuilder(String scheme)
Get the configuration builder for the given scheme.
|
FileOperationProvider[] |
DefaultFileSystemManager.getOperationProviders(String scheme) |
FileObject |
DecoratedFileObject.getParent() |
Collection<Capability> |
DefaultFileSystemManager.getProviderCapabilities(String scheme)
Get the capabilities for a given scheme.
|
FileReplicator |
DefaultFileSystemManager.getReplicator()
Returns the file replicator.
|
TemporaryFileStore |
DefaultFileSystemManager.getTemporaryFileStore()
Returns the temporary file store.
|
FileType |
SynchronizedFileObject.getType() |
FileType |
DecoratedFileObject.getType() |
URL |
DecoratedFileObject.getURL() |
void |
DefaultFileReplicator.init()
Initialises this component.
|
void |
DefaultFileSystemManager.init()
Initialises this manager.
|
void |
PrivilegedFileReplicator.init()
Initialises the component.
|
void |
StandardFileSystemManager.init()
Initializes this manager.
|
boolean |
SynchronizedFileObject.isHidden() |
boolean |
DecoratedFileObject.isHidden() |
boolean |
SynchronizedFileObject.isReadable() |
boolean |
DecoratedFileObject.isReadable() |
boolean |
SynchronizedFileObject.isWriteable() |
boolean |
DecoratedFileObject.isWriteable() |
void |
SynchronizedFileObject.moveTo(FileObject destFile) |
void |
DecoratedFileObject.moveTo(FileObject destFile) |
void |
DecoratedFileObject.refresh() |
void |
VirtualFileSystem.removeJunction(String junctionPoint)
Removes a junction from this file system.
|
File |
DefaultFileReplicator.replicateFile(FileObject srcFile,
FileSelector selector)
Creates a local copy of the file, and all its descendents.
|
File |
PrivilegedFileReplicator.replicateFile(FileObject srcFile,
FileSelector selector)
Creates a local copy of the file, and all its descendents.
|
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, realtive to a base file with specified FileSystem
configuration.
|
FileObject |
DefaultFileSystemManager.resolveFile(File baseFile,
String uri)
Locates a file by URI.
|
FileObject |
DefaultFileSystemManager.resolveFile(String uri)
Locates a file by URI.
|
FileObject |
SynchronizedFileObject.resolveFile(String path) |
FileObject |
DecoratedFileObject.resolveFile(String path) |
FileObject |
DefaultFileSystemManager.resolveFile(String uri,
FileSystemOptions fileSystemOptions)
Locate a file by URI, use the FileSystemOptions for file-system creation.
|
FileObject |
SynchronizedFileObject.resolveFile(String name,
NameScope scope) |
FileObject |
DecoratedFileObject.resolveFile(String name,
NameScope scope) |
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 filename.
|
void |
DefaultFileSystemManager.setBaseFile(File baseFile)
Sets the base file to use when resolving relative URI.
|
void |
DefaultFileSystemManager.setBaseFile(FileObject baseFile)
Sets the base file to use when resolving relative URI.
|
void |
DefaultFileSystemManager.setCacheStrategy(CacheStrategy fileCacheStrategy)
Set the cache strategy to use when dealing with file object data.
|
void |
DefaultFileSystemManager.setDefaultProvider(FileProvider provider)
Sets the default provider.
|
void |
DefaultFileSystemManager.setFileContentInfoFactory(FileContentInfoFactory fileContentInfoFactory)
set the fileContentInfoFactory used to determine the infos of a file
content.
|
void |
DefaultFileSystemManager.setFileObjectDecorator(Class<?> fileObjectDecorator)
Set a fileObject decorator to be used for ALL returned file objects.
|
void |
DefaultFileSystemManager.setFilesCache(FilesCache filesCache)
Sets the filesCache implementation used to cache files.
|
void |
DefaultFileSystemManager.setReplicator(FileReplicator replicator)
Sets the file replicator to use.
|
void |
DefaultFileSystemManager.setTemporaryFileStore(TemporaryFileStore tempFileStore)
Sets the temporary file store to use.
|
void |
DefaultFileSystemConfigBuilder.setUserAuthenticator(FileSystemOptions opts,
UserAuthenticator userAuthenticator)
Sets the user authenticator to get authentication informations.
|
FileObject |
DefaultFileSystemManager.toFileObject(File file)
Converts a local file into a
FileObject . |
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractFileOperationProvider.addOperation(Class<? extends FileOperation> operationClass) |
void |
FileOperationProvider.collectOperations(Collection<Class<? extends FileOperation>> operationsList,
FileObject file)
Gather available operations for the specified FileObject and put them into
specified operationsList.
|
void |
AbstractFileOperationProvider.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) |
FileOperation |
DefaultFileOperations.getOperation(Class<? extends FileOperation> operationClass) |
FileOperation |
FileOperations.getOperation(Class<? extends FileOperation> operationClass) |
FileOperation |
FileOperationProvider.getOperation(FileObject file,
Class<? extends FileOperation> operationClass) |
FileOperation |
AbstractFileOperationProvider.getOperation(FileObject file,
Class<? extends FileOperation> operationClass) |
Class<? extends FileOperation>[] |
DefaultFileOperations.getOperations() |
Class<? extends FileOperation>[] |
FileOperations.getOperations() |
boolean |
DefaultFileOperations.hasOperation(Class<? extends FileOperation> operationClass) |
boolean |
FileOperations.hasOperation(Class<? extends FileOperation> operationClass) |
protected abstract FileOperation |
AbstractFileOperationProvider.instantiateOperation(FileObject file,
Class<? extends FileOperation> operationClass) |
protected Class<? extends FileOperation> |
AbstractFileOperationProvider.lookupOperation(Class<? extends FileOperation> operationClass) |
void |
FileOperation.process()
Performs necessary actions that are related to the concrete
implementation of a FileOperation.
|
Modifier and Type | Method and Description |
---|---|
void |
VcsLogEntryHandler.handleLogEntry(VcsLogEntry entry) |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractVfsContainer.addComponent(Object component)
Adds a sub-component to this component.
|
protected void |
AbstractFileProvider.addFileSystem(Comparable<?> key,
FileSystem fs)
Adds a file system to those cached by this provider.
|
void |
AbstractFileSystem.addJunction(String junctionPoint,
FileObject targetFile)
Adds a junction to this file system.
|
File |
TemporaryFileStore.allocateFile(String basename)
Allocates a new temporary file.
|
static void |
UriParser.canonicalizePath(StringBuilder buffer,
int offset,
int length,
FileNameParser fileNameParser) |
static void |
UriParser.checkUriEncoding(String uri)
Decodes the String.
|
void |
AbstractFileObject.close()
Closes this file, and its content.
|
void |
DelegateFileObject.close()
Close the delegated file.
|
void |
DefaultFileContent.close()
Closes all resources used by the content, including all streams, readers
and writers.
|
void |
AbstractFileObject.copyFrom(FileObject file,
FileSelector selector)
Copies another file to this file.
|
void |
AbstractFileObject.createFile()
Creates this file, if it does not exist.
|
FileObject |
AbstractFileProvider.createFileSystem(String scheme,
FileObject file,
FileSystemOptions properties)
Creates a layered file system.
|
FileObject |
FileProvider.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.
|
void |
AbstractFileObject.createFolder()
Creates this folder, if it does not exist.
|
static String |
UriParser.decode(String encodedStr)
Removes %nn encodings from a string.
|
static void |
UriParser.decode(StringBuilder buffer,
int offset,
int length)
Removes %nn encodings from a string.
|
protected FileObject |
AbstractFileSystem.decorateFileObject(FileObject file) |
boolean |
AbstractFileObject.delete()
Deletes this file.
|
int |
AbstractFileObject.delete(FileSelector selector)
Deletes this file, and all children.
|
protected FileContent |
AbstractFileObject.doCreateFileContent()
Create a FileContent implementation.
|
protected abstract FileSystem |
AbstractOriginatingFileProvider.doCreateFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions)
Creates a
FileSystem . |
protected abstract FileSystem |
AbstractLayeredFileProvider.doCreateFileSystem(String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
protected FileType |
DelegateFileObject.doGetType()
Determines the type of the file, returns null if the file does not
exist.
|
protected boolean |
DelegateFileObject.doIsHidden()
Determines if this file is hidden.
|
protected boolean |
DelegateFileObject.doIsReadable()
Determines if this file can be read.
|
protected boolean |
AbstractFileObject.doIsSameFile(FileObject destFile)
Checks if this fileObject is the same file as
destFile just with a different
name.E.g. |
protected boolean |
DelegateFileObject.doIsWriteable()
Determines if this file can be written to.
|
boolean |
AbstractFileObject.exists()
Determines if the file exists.
|
protected int |
HostFileNameParser.extractPort(StringBuilder name,
String uri)
Extracts the port from a URI.
|
protected String |
LayeredFileNameParser.extractRootName(StringBuilder uri)
Pops the root prefix off a URI, which has had the scheme removed.
|
protected HostFileNameParser.Authority |
HostFileNameParser.extractToPath(String uri,
StringBuilder name)
Extracts the scheme, userinfo, hostname and port components of a
generic URI.
|
protected FileObject |
AbstractOriginatingFileProvider.findFile(FileName name,
FileSystemOptions fileSystemOptions)
Locates a file from its parsed URI.
|
FileObject |
AbstractOriginatingFileProvider.findFile(FileObject baseFile,
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 |
AbstractLayeredFileProvider.findFile(FileObject baseFile,
String uri,
FileSystemOptions properties)
Locates a file object, by absolute URI.
|
FileObject[] |
AbstractFileObject.findFiles(FileSelector selector)
Finds the set of matching descendents of this file, in depthwise
order.
|
void |
AbstractFileObject.findFiles(FileSelector selector,
boolean depthwise,
List<FileObject> selected)
Traverses the descendents of this file, and builds a list of selected
files.
|
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.
|
Object |
AbstractFileSystem.getAttribute(String attrName)
Retrieves the attribute with the specified name.
|
Object |
DefaultFileContent.getAttribute(String attrName)
Gets the value of an attribute.
|
String[] |
DefaultFileContent.getAttributeNames()
Lists the attributes of this file.
|
Map<String,Object> |
DefaultFileContent.getAttributes()
Returns a read-only map of this file's attributes.
|
Certificate[] |
DefaultFileContent.getCertificates()
Returns the certificates used to sign this file.
|
FileObject |
AbstractFileObject.getChild(String name)
Returns a child of this file.
|
FileObject[] |
AbstractFileObject.getChildren()
Returns the children of the file.
|
FileContent |
AbstractFileObject.getContent()
Returns the file's content.
|
FileContentInfo |
DefaultFileContent.getContentInfo()
get the content info.
|
FileOperations |
AbstractFileObject.getFileOperations() |
protected FileSystem |
AbstractOriginatingFileProvider.getFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions)
Returns the FileSystem associated with the specified root.
|
InputStream |
AbstractFileObject.getInputStream()
Returns an input stream to use to read the content of the file.
|
InputStream |
DefaultFileContent.getInputStream()
Returns an input stream for reading the content.
|
long |
DefaultFileContent.getLastModifiedTime()
Returns the last-modified timestamp.
|
OutputStream |
AbstractFileObject.getOutputStream()
Prepares this file for writing.
|
OutputStream |
DefaultFileContent.getOutputStream()
Returns an output stream for writing the content.
|
OutputStream |
AbstractFileObject.getOutputStream(boolean bAppend)
Prepares this file for writing.
|
OutputStream |
DefaultFileContent.getOutputStream(boolean bAppend)
Returns an output stream for writing the content in append mode.
|
FileObject |
AbstractFileObject.getParent()
Returns the parent of the file.
|
FileObject |
AbstractFileSystem.getParentLayer()
Returns the parent layer if this is a layered file system.
|
String |
AbstractFileName.getPathDecoded()
Returns the decoded path.
|
String |
URLFileName.getPathQueryEncoded(String charset)
Get the path encoded suitable for url like filesystem e.g.
|
RandomAccessContent |
AbstractFileObject.getRandomAccessContent(RandomAccessMode mode)
Returns an input/output stream to use to read and write the content of the file in and
random manner.
|
RandomAccessContent |
DefaultFileContent.getRandomAccessContent(RandomAccessMode mode)
Returns an input/output stream to use to read and write the content of the file in an
random manner.
|
String |
AbstractFileName.getRelativeName(FileName name)
Converts a file name to a relative name, relative to this file name.
|
FileReplicator |
VfsComponentContext.getReplicator()
Locates a file replicator for the provider to use.
|
FileObject |
AbstractFileSystem.getRoot()
Returns the root file of this file system.
|
long |
DefaultFileContent.getSize()
Returns the size of the content (in bytes).
|
TemporaryFileStore |
VfsComponentContext.getTemporaryFileStore()
Locates a temporary file store for the provider to use.
|
FileType |
AbstractFileObject.getType()
Returns the file's type.
|
String |
URLFileName.getURIEncoded(String charset)
Encode a URI.
|
URL |
AbstractFileObject.getURL()
Returns a URL representation of the file.
|
boolean |
DefaultFileContent.hasAttribute(String attrName)
Checks if an attribute exists.
|
void |
AbstractVfsComponent.init()
Initialises the component.
|
void |
AbstractFileSystem.init()
Initialises this component.
|
void |
VfsComponent.init()
Initialises the component.
|
boolean |
AbstractFileObject.isHidden()
Determines if this file can be read.
|
boolean |
AbstractFileObject.isReadable()
Determines if this file can be read.
|
protected boolean |
AbstractFileObject.isSameFile(FileObject destFile)
Checks if this fileObject is the same file as
destFile just with a different
name.E.g. |
boolean |
AbstractFileObject.isWriteable()
Determines if this file can be written to.
|
void |
AbstractFileObject.moveTo(FileObject destFile)
Moves (rename) the file to another one.
|
static FileType |
UriParser.normalisePath(StringBuilder path)
Normalises a path.
|
FileName |
AbstractFileProvider.parseUri(FileName base,
String uri)
Parses an absolute URI.
|
FileName |
FileProvider.parseUri(FileName root,
String uri)
Parse the URI into a FileName.
|
FileName |
VfsComponentContext.parseURI(String uri)
Parse a URI into a FileName.
|
FileName |
URLFileNameParser.parseUri(VfsComponentContext context,
FileName base,
String filename) |
FileName |
LayeredFileNameParser.parseUri(VfsComponentContext context,
FileName base,
String filename)
Parse the base and name into a FileName.
|
FileName |
HostFileNameParser.parseUri(VfsComponentContext context,
FileName base,
String filename) |
FileName |
FileNameParser.parseUri(VfsComponentContext context,
FileName base,
String filename)
parses a String into a filename.
|
void |
AbstractFileObject.refresh()
This will prepare the fileObject to get resynchronized with the underlaying filesystem if required.
|
void |
DelegateFileObject.refresh()
Refresh file information.
|
void |
DefaultFileContent.removeAttribute(String attrName)
Removes an attribute.
|
void |
AbstractFileSystem.removeJunction(String junctionPoint)
Removes a junction from this file system.
|
File |
AbstractFileSystem.replicateFile(FileObject file,
FileSelector selector)
Creates a temporary local copy of a file and its descendents.
|
File |
FileReplicator.replicateFile(FileObject srcFile,
FileSelector selector)
Creates a local copy of the file, and all its descendents.
|
FileObject |
AbstractFileSystem.resolveFile(FileName name)
Finds a file in this file system.
|
FileObject |
VfsComponentContext.resolveFile(FileObject baseFile,
String name,
FileSystemOptions fileSystemOptions)
Locate a file by name.
|
FileObject |
AbstractFileSystem.resolveFile(String nameStr)
Finds a file in this file system.
|
FileObject |
AbstractFileObject.resolveFile(String path)
Finds a file, relative to this file.
|
FileObject |
VfsComponentContext.resolveFile(String name,
FileSystemOptions fileSystemOptions)
Locate a file by name.
|
FileObject |
AbstractFileObject.resolveFile(String name,
NameScope scope)
Returns a child by name.
|
void |
AbstractFileSystem.setAttribute(String attrName,
Object value)
Sets the attribute with the specified name.
|
void |
DefaultFileContent.setAttribute(String attrName,
Object value)
Sets the value of an attribute.
|
void |
DefaultFileContent.setLastModifiedTime(long modTime)
Sets the last-modified timestamp.
|
FileObject |
VfsComponentContext.toFileObject(File file)
Returns a
FileObject for a local file. |
Constructor and Description |
---|
DelegateFileObject(AbstractFileName name,
AbstractFileSystem fileSystem,
FileObject file) |
Modifier and Type | Method and Description |
---|---|
protected FileObject |
Bzip2FileSystem.createFile(AbstractFileName name) |
protected FileSystem |
Bzip2FileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
void |
CompressedFileFileObject.createFile() |
protected abstract FileObject |
CompressedFileFileSystem.createFile(AbstractFileName name)
Creates a file object.
|
protected abstract FileSystem |
CompressedFileFileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
protected FileSystem |
CompressedFileFileProvider.doCreateFileSystem(String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
protected FileType |
CompressedFileFileObject.doGetType()
Returns the file's type.
|
void |
CompressedFileFileSystem.init() |
boolean |
CompressedFileFileObject.isWriteable()
Determines if this file can be written to.
|
Modifier and Type | Method and Description |
---|---|
static org.apache.commons.net.ftp.FTPClient |
FtpClientFactory.createConnection(String hostname,
int port,
char[] username,
char[] password,
String workingDirectory,
FileSystemOptions fileSystemOptions)
Creates a new connection to the server.
|
protected FileObject |
FtpFileSystem.createFile(AbstractFileName name)
Creates a file object.
|
protected FileSystem |
FtpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates the filesystem.
|
FileObject[] |
FtpFileObject.getChildren()
Returns the file's list of children.
|
FtpClient |
FtpFileSystem.getClient()
Creates an FTP client to use.
|
boolean |
FtpClient.isConnected() |
void |
FtpFileObject.refresh() |
Constructor and Description |
---|
FtpFileObject(AbstractFileName name,
FtpFileSystem fileSystem,
FileName rootName) |
Modifier and Type | Method and Description |
---|---|
static org.apache.commons.net.ftp.FTPSClient |
FtpsClientFactory.createConnection(String hostname,
int port,
char[] username,
char[] password,
String workingDirectory,
FileSystemOptions fileSystemOptions)
Creates a new connection to the server.
|
protected FileSystem |
FtpsFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates the filesystem.
|
Modifier and Type | Method and Description |
---|---|
protected FileObject |
GzipFileSystem.createFile(AbstractFileName name) |
protected FileSystem |
GzipFileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
FileContentInfo |
HttpFileContentInfoFactory.create(FileContent fileContent) |
static org.apache.commons.httpclient.HttpClient |
HttpClientFactory.createConnection(HttpFileSystemConfigBuilder builder,
String scheme,
String hostname,
int port,
String username,
String password,
FileSystemOptions fileSystemOptions)
Creates a new connection to the server.
|
static org.apache.commons.httpclient.HttpClient |
HttpClientFactory.createConnection(String scheme,
String hostname,
int port,
String username,
String password,
FileSystemOptions fileSystemOptions) |
protected FileSystem |
HttpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates a
FileSystem . |
protected void |
HttpFileObject.setupMethod(org.apache.commons.httpclient.HttpMethod method)
Prepares a Method object.
|
Modifier and Type | Method and Description |
---|---|
protected ZipFile |
JarFileSystem.createZipFile(File file) |
protected ZipFileObject |
JarFileSystem.createZipFileObject(AbstractFileName name,
ZipEntry entry) |
protected FileSystem |
JarFileProvider.doCreateFileSystem(String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
Object |
JarFileSystem.getAttribute(String attrName)
Retrives the attribute with the specified name.
|
protected ZipFile |
JarFileSystem.getZipFile() |
Constructor and Description |
---|
JarFileObject(AbstractFileName name,
ZipEntry entry,
JarFileSystem fs,
boolean zipExists) |
JarFileSystem(AbstractFileName rootName,
FileObject file,
FileSystemOptions fileSystemOptions) |
JarURLConnectionImpl(JarFileObject file,
FileContent content) |
Modifier and Type | Method and Description |
---|---|
protected FileObject |
LocalFileSystem.createFile(AbstractFileName name)
Creates a file object.
|
protected FileSystem |
DefaultLocalFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates the filesystem.
|
protected long |
LocalFile.doGetLastModifiedTime()
Gets the last modified time of this file.
|
protected boolean |
LocalFile.doIsReadable()
Determines if this file can be read.
|
protected boolean |
LocalFile.doIsSameFile(FileObject destFile) |
protected boolean |
LocalFile.doIsWriteable()
Determines if this file can be written to.
|
protected boolean |
LocalFile.doSetLastModifiedTime(long modtime)
Sets the last modified time of this file.
|
protected String |
WindowsFileNameParser.extractRootPrefix(String uri,
StringBuilder name)
Pops the root prefix off a URI, which has had the scheme removed.
|
protected String |
GenericFileNameParser.extractRootPrefix(String uri,
StringBuilder name)
Pops the root prefix off a URI, which has had the scheme removed.
|
protected abstract String |
LocalFileNameParser.extractRootPrefix(String uri,
StringBuilder name)
Pops the root prefix off a URI, which has had the scheme removed.
|
FileObject |
DefaultLocalFileProvider.findLocalFile(File file)
Finds a local file.
|
FileObject |
DefaultLocalFileProvider.findLocalFile(String name)
Finds a local file, from its local name.
|
FileName |
LocalFileNameParser.parseUri(VfsComponentContext context,
FileName base,
String filename) |
Constructor and Description |
---|
LocalFile(LocalFileSystem fileSystem,
String rootFile,
AbstractFileName name)
Creates a non-root file.
|
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
RamFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions) |
void |
RamFileSystem.importTree(File file)
Import a Tree.
|
Modifier and Type | Method and Description |
---|---|
FileObject |
ResourceFileProvider.findFile(FileObject baseFile,
String uri,
FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.
|
Modifier and Type | Method and Description |
---|---|
static com.jcraft.jsch.Session |
SftpClientFactory.createConnection(String hostname,
int port,
char[] username,
char[] password,
FileSystemOptions fileSystemOptions)
Creates a new connection to the server.
|
protected FileObject |
SftpFileSystem.createFile(AbstractFileName name)
Creates a file object.
|
protected FileSystem |
SftpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates a
FileSystem . |
void |
SftpFileProvider.init()
Initialises the component.
|
void |
SftpFileObject.refresh() |
void |
SftpFileSystemConfigBuilder.setCompression(FileSystemOptions opts,
String compression)
configure the compression to use.
e.g. |
void |
SftpFileSystemConfigBuilder.setIdentities(FileSystemOptions opts,
File[] identities)
Set the identity files (your private key files).
Need to use a java.io.File as JSch cant deal with vfs FileObjects ;-) |
void |
SftpFileSystemConfigBuilder.setKnownHosts(FileSystemOptions opts,
File sshdir)
Set the known_hosts file.
|
void |
SftpFileSystemConfigBuilder.setStrictHostKeyChecking(FileSystemOptions opts,
String hostKeyChecking)
configure the host key checking to use.
valid arguments are only yes, no and ask. See the jsch documentation for details. |
Constructor and Description |
---|
SftpFileObject(AbstractFileName name,
SftpFileSystem fileSystem) |
Modifier and Type | Method and Description |
---|---|
protected FileObject |
TarFileSystem.createFile(AbstractFileName name)
Creates a file object.
|
protected org.apache.commons.vfs2.provider.tar.TarInputStream |
TarFileSystem.createTarFile(File file) |
protected TarFileObject |
TarFileSystem.createTarFileObject(AbstractFileName name,
org.apache.commons.vfs2.provider.tar.TarEntry entry) |
protected FileSystem |
TarFileProvider.doCreateFileSystem(String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
InputStream |
TarFileSystem.getInputStream(org.apache.commons.vfs2.provider.tar.TarEntry entry) |
protected org.apache.commons.vfs2.provider.tar.TarInputStream |
TarFileSystem.getTarFile() |
void |
TarFileSystem.init() |
boolean |
TarFileObject.isWriteable()
Determines if this file can be written to.
|
protected void |
TarFileSystem.resetTarFile() |
Constructor and Description |
---|
TarFileObject(AbstractFileName name,
org.apache.commons.vfs2.provider.tar.TarEntry entry,
TarFileSystem fs,
boolean tarExists) |
TarFileSystem(AbstractFileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
FileObject |
TemporaryFileProvider.findFile(FileObject baseFile,
String uri,
FileSystemOptions properties)
Locates a file object, by absolute URI.
|
Modifier and Type | Method and Description |
---|---|
protected URL |
UrlFileObject.createURL(FileName name) |
FileObject |
UrlFileProvider.findFile(FileObject baseFile,
String uri,
FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.
|
FileName |
UrlFileNameParser.parseUri(VfsComponentContext context,
FileName base,
String filename)
Parse a URI.
|
Modifier and Type | Method and Description |
---|---|
protected FileObject |
ZipFileSystem.createFile(AbstractFileName name)
Creates a file object.
|
protected ZipFile |
ZipFileSystem.createZipFile(File file) |
protected ZipFileObject |
ZipFileSystem.createZipFileObject(AbstractFileName name,
ZipEntry entry) |
protected FileSystem |
ZipFileProvider.doCreateFileSystem(String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
protected ZipFile |
ZipFileSystem.getZipFile() |
void |
ZipFileSystem.init() |
boolean |
ZipFileObject.isWriteable()
Determines if this file can be written to.
|
Constructor and Description |
---|
ZipFileObject(AbstractFileName name,
ZipEntry entry,
ZipFileSystem fs,
boolean zipExists) |
ZipFileSystem(AbstractFileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected void |
CopyTask.handleOutOfDateFile(FileObject srcFile,
FileObject destFile)
Handles an out-of-date file.
|
protected void |
MoveTask.handleOutOfDateFile(FileObject srcFile,
FileObject destFile)
Handles a single source file.
|
protected void |
CopyTask.handleUpToDateFile(FileObject srcFile,
FileObject destFile)
Handles an up-to-date file.
|
protected FileObject |
VfsTask.resolveFile(String uri)
Resolves a URI to a file, relative to the project's base directory.
|
Modifier and Type | Method and Description |
---|---|
protected void |
MonitorOutputStream.assertOpen()
check if file is still open.
|
static AbstractFileObject |
FileObjectUtils.getAbstractFileObject(FileObject fileObject)
Get access to the base object even if decorated.
|
static boolean |
FileObjectUtils.isInstanceOf(FileObject fileObject,
Class<?> wantedClass)
Check if the given FileObject is instance of given class argument.
|
void |
DelegatingFileSystemOptionsBuilder.setConfigClass(FileSystemOptions fso,
String scheme,
String name,
Class<?> className)
Set a single class value.
The class has to implement a no-args constructor, else the instantiation might fail. |
void |
DelegatingFileSystemOptionsBuilder.setConfigClasses(FileSystemOptions fso,
String scheme,
String name,
Class<?>[] classNames)
Set an array of class values.
The class has to implement a no-args constructor, else the instantiation might fail. |
void |
DelegatingFileSystemOptionsBuilder.setConfigString(FileSystemOptions fso,
String scheme,
String name,
String value)
Set a single string value.
|
void |
DelegatingFileSystemOptionsBuilder.setConfigStrings(FileSystemOptions fso,
String scheme,
String name,
String[] values)
Set an array of string value.
|
Copyright © 2002–2015 The Apache Software Foundation. All rights reserved.