Package org.apache.commons.vfs2.provider.ram

Class RamFileSystem

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractFileSystem

org.apache.commons.vfs2.provider.ram.RamFileSystem

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, FileSystem, VfsComponent

public class RamFileSystem
extends AbstractFileSystem
implements Serializable

A RAM File System.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<FileName,RamFileData>	cache	Cache of RAM File Data
private static final long	serialVersionUID	serialVersionUID format is YYYYMMDD for the date of the last binary change.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addCapabilities(Collection<Capability> caps)	Adds the capabilities of this file system.
void	attach(RamFileObject ramFileObject)	Attaches this instance to the given RamFileObject.
void	close()	Close the RAMFileSystem.
protected FileObject	createFile(AbstractFileName name)	Creates a file object.
(package private) void	delete(RamFileObject file)	Delete a file
void	importTree(File file)	Import a Tree.
(package private) String[]	listChildren(FileName name)
(package private) void	rename(RamFileObject from, RamFileObject to)
(package private) void	save(RamFileObject file)	Saves a file
(package private) long	size()
private void	toRamFileObject(FileObject fo, FileObject root)	Import the given file with the name relative to the given root

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

addJunction, addListener, closeCommunicationLink, decorateFileObject, doCloseCommunicationLink, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileFromCache, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, init, isOpen, isReleaseable, notifyAllStreamsClosed, putFileToCache, removeFileFromCache, removeJunction, removeListener, replicateFile, resolveFile, resolveFile, setAttribute

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

getContext, getLogger, setContext, setLogger

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

serialVersionUID format is YYYYMMDD for the date of the last binary change.

See Also:

• Constant Field Values

cache

private final Map<FileName,RamFileData> cache

Cache of RAM File Data

Constructor Details

RamFileSystem

protected RamFileSystem(FileName rootName,
 FileSystemOptions fileSystemOptions)

Constructs a new instance.

Parameters:

rootName - The root file name of this file system.

fileSystemOptions - Options to build this file system.

Method Details

addCapabilities

protected void addCapabilities(Collection<Capability> caps)

Description copied from class: AbstractFileSystem

Adds the capabilities of this file system.

Specified by:

addCapabilities in class AbstractFileSystem

Parameters:

caps - collections of Capabilities, can be immutable.

attach

public void attach(RamFileObject ramFileObject)

Attaches this instance to the given RamFileObject.

Parameters:

ramFileObject - A RAM file object.

close

public void close()

Close the RAMFileSystem.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface VfsComponent

Overrides:

close in class AbstractFileSystem

createFile

protected FileObject createFile(AbstractFileName name)
                         throws Exception

Description copied from class: AbstractFileSystem

Creates a file object.

This method is called only if the requested file is not cached.

Specified by:

createFile in class AbstractFileSystem

Parameters:

name - name referencing the new file.

Returns:

new created FileObject.

Throws:

Exception - might throw an Exception, which is then wrapped in FileSystemException.

delete

void delete(RamFileObject file)
     throws FileSystemException

Delete a file

Parameters:

file - the RamFileObject file to delete.

Throws:

FileSystemException - Thrown for file system errors.

importTree

public void importTree(File file)
                throws FileSystemException

Import a Tree.

Parameters:

file - The File

Throws:

FileSystemException - if an error occurs.

listChildren

String[] listChildren(FileName name)

Parameters:

name - The name of the file.

Returns:

children The names of the children.

rename

void rename(RamFileObject from,
 RamFileObject to)
     throws FileSystemException

Parameters:

from - The original file.

to - The new file.

Throws:

FileSystemException - if an error occurs.

save

void save(RamFileObject file)
   throws FileSystemException

Saves a file

Parameters:

file - the RamFileObject file to save.

Throws:

FileSystemException - Thrown for file system errors.

size

long size()

Returns:

Returns the size of the FileSystem

toRamFileObject

private void toRamFileObject(FileObject fo,
 FileObject root)
                      throws FileSystemException

Import the given file with the name relative to the given root

Parameters:

fo - the source FileObject file to import.

root - the FileObject root.

Throws:

FileSystemException - Thrown for file system errors.