Module utilities

Package de.grogra.vfs

Class FileSystem

java.lang.Object

de.grogra.util.TreeModelSupport

de.grogra.vfs.FileSystem

All Implemented Interfaces:

TreeModel

Direct Known Subclasses:

FileSystemBase, LocalFileSystem

public abstract class FileSystem
extends TreeModelSupport
implements TreeModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FileSystem.Out

Field Summary

Fields

Modifier and Type	Field	Description
protected FileNameMap	fileNameMap
protected Manifest	manifest
static final MimeType	MIME_TYPE

Fields inherited from class de.grogra.util.TreeModelSupport

NODES_CHANGED, NODES_INSERTED, NODES_REMOVED, STRUCTURE_CHANGED

Constructor Summary

Constructors

Constructor	Description
FileSystem(String fsName, String protocol)

Method Summary

Modifier and Type	Method	Description
Object	addFile(Object source, Object targetDir, String name, boolean createDir)
Object	addFile(Object source, Object targetDir, String name, boolean createDir, boolean ensureNew)
Object	addLocalFile(Object source, Object targetDir, String name)
Object	addLocalFile(Object source, Object targetDir, String name, boolean createDir)
Object	addLocalFile(Object source, Object targetDir, String name, boolean createDir, boolean ensureNew)
Object[]	completeListFiles(Object parent)	Loop over all files and their children to get all files, including in subrepositories from the parent.
void	copyFilesTo(Collection list, FileSystem fs)
Object	copyFileTo(Object file, FileSystem fs)
void	copyFileTo(Object file, FileSystem fs, Object destFile)
Object	copyFileToDirectory(Object file, FileSystem fs, Object destDir)
Object	copyFileToDirectory(Object file, FileSystem fs, Object destDir, String name)
Object	create(Object parent, String name, boolean createDirectory)
Object	create(Object parent, String name, boolean createDirectory, boolean ensureNew)
Object	createIfDoesntExist(Object parent, Object[] path, boolean isDirectory, boolean ensureNew)	Get a file/memory entry Or create it including all parent directories up to the ResourceDir
Object	createIfDoesntExist(Object parent, Object file, boolean isDirectory, boolean ensureNew)
Object	createIfDoesntExist(Object parent, String path, boolean isDirectory, boolean ensureNew)
protected abstract Object	createImpl(Object parent, String name, boolean createDirectory)
abstract void	delete(Object file)
String	ensureNewDir(Object parent, String name)	Check if another directory has the same name in the parent
String	ensureNewFile(Object parent, String name)	Check at the root of the filesystem if another file has the same FileName basename is the file name (i.e.
boolean	equals(Object a, Object b)
Collection<String>	findAll(String name, Object parent)	Return all the systemId of file with the given name recursively to the given parent
protected Object	fireInserted(Object createImplRet)
String	getAbsolutePath(Object file)
String	getAttribute(Object file, String name)
String	getAttribute(Object file, Attributes.Name name)
Attributes	getAttributes(Object file, boolean create)
String	getBaseName(Object file)
String	getBaseName(String name)
Charset	getCharset(Object file)
Object	getChild(Object parent, int index)
int	getChildCount(Object file)
TreeModelEvent	getEventFor(Object file)
abstract Object	getFile(Object parent, String name)
Object	getFile(String path)
static Object	getFile(TreeModelEvent e)
String	getFSName()
int	getIndexOfChild(Object parent, Object file)
abstract InputStream	getInputStream(Object file)
final Manifest	getManifest()
protected String	getManifestName(Object file)
MimeType	getMimeType(Object file)
abstract String	getName(Object file)
abstract OutputStream	getOutputStream(Object file, boolean append)
abstract Object	getParent(Object file)
String	getPath(Object file)
final String	getPathWithLeadingSlash(Object file)
String	getProtocol()
Reader	getReader(Object file)
abstract Object	getRoot()
abstract long	getSize(Object file)
abstract long	getTime(Object file)
TreePath	getTreePath(Object file)
Writer	getWriter(Object file, boolean append)
static boolean	isContainedInChildren(Object file, TreeModelEvent e)
boolean	isDirectory(Object file)
boolean	isIn(String name)
abstract boolean	isPersistent()
abstract boolean	isReadOnly(Object file)
abstract Object[]	listFiles(Object parent)
void	readJar(InputStream in, boolean verify)
abstract void	remove(Object file)	Remove a file from the filesystem.
void	removeNonlistedAttributes(Collection list)
void	setFileNameMap(FileNameMap map)
void	setManifest(Manifest manifest)
void	setMimeType(Object file, MimeType t)
abstract void	setTime(Object file, long time)
abstract Object	toFile(URL url)
abstract URL	toURL(Object file)
void	valueForPathChanged(TreePath path, Object value)
void	writeJar(OutputStream out)
void	writeJar(JarOutputStream out, byte[] buf, Object file, ObjectToBoolean<Object> filter)

Methods inherited from class de.grogra.util.TreeModelSupport

addTreeModelListener, allListenersRemoved, clearListeners, fireTreeModelEvent, fireTreeModelEvent, fireTreeModelEvent, fireTreeModelEvent, firstListenerAdded, hasListeners, removeTreeModelListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.tree.TreeModel

addTreeModelListener, isLeaf, removeTreeModelListener

Field Details

MIME_TYPE

public static final MimeType MIME_TYPE

fileNameMap

protected FileNameMap fileNameMap

manifest

protected Manifest manifest

Constructor Details

FileSystem

public FileSystem(String fsName,
 String protocol)

Method Details

getFSName

public String getFSName()

getProtocol

public String getProtocol()

isPersistent

public abstract boolean isPersistent()

delete

public abstract void delete(Object file)
                     throws IOException

Throws:

IOException

getName

public abstract String getName(Object file)

toURL

public abstract URL toURL(Object file)

toFile

public abstract Object toFile(URL url)

getParent

public abstract Object getParent(Object file)

isReadOnly

public abstract boolean isReadOnly(Object file)

getTime

public abstract long getTime(Object file)

setTime

public abstract void setTime(Object file,
 long time)

getSize

public abstract long getSize(Object file)

getRoot

public abstract Object getRoot()

Specified by:

getRoot in interface TreeModel

listFiles

public abstract Object[] listFiles(Object parent)

getFile

public abstract Object getFile(Object parent,
 String name)

remove

public abstract void remove(Object file)

Remove a file from the filesystem. It does not delete it if its local

Parameters:

file -

Throws:

IOException

equals

public boolean equals(Object a,
 Object b)

create

public Object create(Object parent,
 String name,
 boolean createDirectory)
              throws IOException

Parameters:

parent - parent is a Entry object in memory file system/ a File in localfilesystem

name -

createDirectory -

Returns:

Throws:

IOException

create

public Object create(Object parent,
 String name,
 boolean createDirectory,
 boolean ensureNew)
              throws IOException

Throws:

IOException

ensureNewFile

public String ensureNewFile(Object parent,
 String name)

Check at the root of the filesystem if another file has the same FileName basename is the file name (i.e. /dir1/dir2/files.rgg -> basename is "files.rgg", while base is "files" and ext is ".rgg".

Parameters:

parent - a File or an Entry

name -

Returns:

getBaseName

public String getBaseName(String name)

getBaseName

public String getBaseName(Object file)

completeListFiles

public Object[] completeListFiles(Object parent)

Loop over all files and their children to get all files, including in subrepositories from the parent. Note that directories are files.

Parameters:

parent -

Returns:

ensureNewDir

public String ensureNewDir(Object parent,
 String name)

Check if another directory has the same name in the parent

Parameters:

parent - a File or an Entry

name -

Returns:

createImpl

protected abstract Object createImpl(Object parent,
 String name,
 boolean createDirectory)
                              throws IOException

Throws:

IOException

fireInserted

protected Object fireInserted(Object createImplRet)

getInputStream

public abstract InputStream getInputStream(Object file)
                                    throws IOException

Throws:

IOException

getOutputStream

public abstract OutputStream getOutputStream(Object file,
 boolean append)
                                      throws IOException

Throws:

IOException

getReader

public Reader getReader(Object file)
                 throws IOException

Throws:

IOException

getWriter

public Writer getWriter(Object file,
 boolean append)
                 throws IOException

Throws:

IOException

getCharset

public Charset getCharset(Object file)

setFileNameMap

public void setFileNameMap(FileNameMap map)

getMimeType

public MimeType getMimeType(Object file)

setMimeType

public void setMimeType(Object file,
 MimeType t)

setManifest

public void setManifest(Manifest manifest)

getManifest

public final Manifest getManifest()

getFile

public Object getFile(String path)

getPath

public String getPath(Object file)

getAbsolutePath

public String getAbsolutePath(Object file)

getPathWithLeadingSlash

public final String getPathWithLeadingSlash(Object file)

getTreePath

public TreePath getTreePath(Object file)

getEventFor

public TreeModelEvent getEventFor(Object file)

getChildCount

public int getChildCount(Object file)

Specified by:

getChildCount in interface TreeModel

getIndexOfChild

public int getIndexOfChild(Object parent,
 Object file)

Specified by:

getIndexOfChild in interface TreeModel

getChild

public Object getChild(Object parent,
 int index)

Specified by:

getChild in interface TreeModel

isContainedInChildren

public static boolean isContainedInChildren(Object file,
 TreeModelEvent e)

getFile

public static Object getFile(TreeModelEvent e)

getAttributes

public Attributes getAttributes(Object file,
 boolean create)

getAttribute

public String getAttribute(Object file,
 Attributes.Name name)

getAttribute

public String getAttribute(Object file,
 String name)

getManifestName

protected String getManifestName(Object file)

readJar

public void readJar(InputStream in,
 boolean verify)
             throws IOException

Throws:

IOException

writeJar

public void writeJar(OutputStream out)
              throws IOException

Throws:

IOException

writeJar

public void writeJar(JarOutputStream out,
 byte[] buf,
 Object file,
 ObjectToBoolean<Object> filter)
              throws IOException

Throws:

IOException

copyFilesTo

public void copyFilesTo(Collection list,
 FileSystem fs)
                 throws IOException

Throws:

IOException

copyFileTo

public Object copyFileTo(Object file,
 FileSystem fs)
                  throws IOException

Throws:

IOException

copyFileTo

public void copyFileTo(Object file,
 FileSystem fs,
 Object destFile)
                throws IOException

Throws:

IOException

copyFileToDirectory

public Object copyFileToDirectory(Object file,
 FileSystem fs,
 Object destDir)
                           throws IOException

Throws:

IOException

copyFileToDirectory

public Object copyFileToDirectory(Object file,
 FileSystem fs,
 Object destDir,
 String name)
                           throws IOException

Throws:

IOException

isDirectory

public boolean isDirectory(Object file)

addLocalFile

public Object addLocalFile(Object source,
 Object targetDir,
 String name)
                    throws IOException

Throws:

IOException

addLocalFile

public Object addLocalFile(Object source,
 Object targetDir,
 String name,
 boolean createDir)
                    throws IOException

Throws:

IOException

addLocalFile

public Object addLocalFile(Object source,
 Object targetDir,
 String name,
 boolean createDir,
 boolean ensureNew)
                    throws IOException

Throws:

IOException

addFile

public Object addFile(Object source,
 Object targetDir,
 String name,
 boolean createDir)
               throws IOException

Parameters:

source - is a FIle or a memory Entry

targetDir - is a File or a memory Entry

name -

createDir -

Returns:

Throws:

IOException

addFile

public Object addFile(Object source,
 Object targetDir,
 String name,
 boolean createDir,
 boolean ensureNew)
               throws IOException

Throws:

IOException

removeNonlistedAttributes

public void removeNonlistedAttributes(Collection list)

createIfDoesntExist

public Object createIfDoesntExist(Object parent,
 Object[] path,
 boolean isDirectory,
 boolean ensureNew)
                           throws IOException

Get a file/memory entry Or create it including all parent directories up to the ResourceDir

Parameters:

parent - File to get

path - An String array of the kind [foo, bar, New dir] (for a path like /foo/bar/New dir)

isDirectory - True if parent is a directory

ensureNew - True if parent needs to be new (i.e. if a parent already exist in the path, it will create parent 2)

Returns:

Throws:

IOException

createIfDoesntExist

public Object createIfDoesntExist(Object parent,
 String path,
 boolean isDirectory,
 boolean ensureNew)
                           throws IOException

Throws:

IOException

createIfDoesntExist

public Object createIfDoesntExist(Object parent,
 Object file,
 boolean isDirectory,
 boolean ensureNew)
                           throws IOException

Throws:

IOException

valueForPathChanged

public void valueForPathChanged(TreePath path,
 Object value)

Specified by:

valueForPathChanged in interface TreeModel

isIn

public boolean isIn(String name)

findAll

public Collection<String> findAll(String name,
 Object parent)

Return all the systemId of file with the given name recursively to the given parent