Package org.apache.commons.vfs2.provider.temp

Class TemporaryFileProvider

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractVfsContainer

org.apache.commons.vfs2.provider.AbstractFileProvider

org.apache.commons.vfs2.provider.temp.TemporaryFileProvider

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<Object>, FileProvider, VfsComponent

public class TemporaryFileProvider
extends AbstractFileProvider
implements Comparable<Object>

A provider for temporary files.

Field Summary

Fields

Modifier and Type	Field	Description
private File	rootFile

Constructor Summary

Constructors

Constructor	Description
TemporaryFileProvider()	Constructs a new instance.
TemporaryFileProvider(File rootFile)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object o)
FileObject	findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions)	Locates a file object, by absolute URI.
Collection<Capability>	getCapabilities()	Gets the file system capabilities.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider

addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getConfigBuilder, getFileNameParser, parseUri, setFileNameParser

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsContainer

addComponent, removeComponent

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rootFile

private File rootFile

Constructor Details

TemporaryFileProvider

public TemporaryFileProvider()

Constructs a new instance.

TemporaryFileProvider

public TemporaryFileProvider(File rootFile)

Constructs a new instance.

Parameters:

rootFile - The root file.

Method Details

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable<Object>

findFile

public FileObject findFile(FileObject baseFile,
 String uri,
 FileSystemOptions fileSystemOptions)
                    throws FileSystemException

Locates a file object, by absolute URI.

Specified by:

findFile in interface FileProvider

Parameters:

baseFile - The base FileObject.

uri - The URI of the file to be located.

fileSystemOptions - FileSystemOptions to use to locate or create the file.

Returns:

The FileObject.

Throws:

FileSystemException - if an error occurs.

getCapabilities

public Collection<Capability> getCapabilities()

Description copied from interface: FileProvider

Gets the file system capabilities.

These are the same as on the file system, but available before the first file system was instantiated.

Specified by:

getCapabilities in interface FileProvider

Returns:

a Collection of the file systems Capabilities.