net.java.truevfs.access.swing

Class TFileTreeModel

java.lang.Object

net.java.truevfs.access.swing.TFileTreeModel

All Implemented Interfaces:

TreeModel

public final class TFileTreeModel
extends Object
implements TreeModel

A TreeModel which traverses TFile instances. The TArchiveDetector of the root of this tree model is used to detect any archive files in the directory tree.

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Constructor and Description
TFileTreeModel(TFile root, FileFilter filter, Comparator<? super TFile> comparator) Creates a new TFileTreeModel which browses the specified root file.

Method Summary

Modifier and Type	Method and Description
void	addTreeModelListener(TreeModelListener l) Adds a listener to this model.
void	cp_p(TFile oldNode, TFile node) Copies oldNode to node preserving its last modification time and updates the tree accordingly.
void	cp_r(TFile oldNode, TFile node) Copies oldNode to node recursively and updates the tree accordingly.
void	cp_rp(TFile oldNode, TFile node) Copies oldNode to node recursively preserving its last modification time and updates the tree accordingly.
void	cp(InputStream in, TFile node) Copies in to node and updates the tree accordingly.
void	cp(TFile oldNode, TFile node) Copies oldNode to node and updates the tree accordingly.
boolean	createNewFile(TFile node) Creates node as a new file in the file system and updates the tree accordingly.
protected void	fireTreeNodesChanged(TreeModelEvent evt) This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel.
protected void	fireTreeNodesInserted(TreeModelEvent evt) This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel.
protected void	fireTreeNodesRemoved(TreeModelEvent evt) This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel.
protected void	fireTreeStructureChanged(TreeModelEvent evt) This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel.
TFile	getChild(Object parent, int index)
int	getChildCount(Object parent)
int	getIndexOfChild(Object parent, Object child)
TFile	getRoot()
boolean	isLeaf(Object node)
void	mkdir(TFile node, boolean recursive) Ensures that node exists as a (virtual) directory in the (federated) file system and updates the tree accordingly.
void	mv(TFile oldNode, TFile node) Moves oldNode to node and updates the tree accordingly.
void	nodeChanged(TFile node) Updates the given node in the tree.
void	nodeInserted(TFile node) Inserts the given node in the tree.
void	nodeInsertedOrStructureChanged(TFile node) Inserts the given node in the tree or reloads the tree structure for the given node if it already exists.
void	nodeRemoved(TFile node) Removes the given node from the tree.
void	refresh() Refreshes the tree structure for the entire tree.
void	refresh(TFile node) Alias for structureChanged(TFile).
void	removeTreeModelListener(TreeModelListener l) Removes a listener from this model.
void	rm_r(TFile node) Deletes the file or (probably not empty) directory node and updates the tree accordingly.
void	rm(TFile node) Deletes the file or empty directory node and updates the tree accordingly.
void	structureChanged(TFile node) Reloads the tree structure for the given node.
void	valueForPathChanged(TreePath path, Object newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

TFileTreeModel

public TFileTreeModel(@CheckForNull
                      TFile root,
                      @CheckForNull
                      FileFilter filter,
                      Comparator<? super TFile> comparator)

Creates a new TFileTreeModel which browses the specified root file. If file is an instance of TFile, its archive detector is used to detect any archive files in the directory tree.

Parameters:

root - The root of this TFileTreeModel. If this is null, an empty tree is created.

filter - Used to filter the files and directories which are present in this TreeModel. If this is null, all files are accepted.

comparator - A comparator for TFile instances or super classes. This must not be null.

Throws:

NullPointerException - If comparator is null.

IllegalArgumentException - If root isn't null and comparing it to itself didn't result in 0.

ClassCastException - If root isn't null and comparator isn't a Comparator for TFile or super class instances.

Method Detail

addTreeModelListener

public void addTreeModelListener(TreeModelListener l)

Adds a listener to this model.

Specified by:

addTreeModelListener in interface TreeModel

Parameters:

l - The listener to add.

cp_p

public void cp_p(TFile oldNode,
                 TFile node)
          throws IOException

Copies oldNode to node preserving its last modification time and updates the tree accordingly. Note that the current selection may get lost.

Throws:

IOException - on any I/O error.

cp_r

public void cp_r(TFile oldNode,
                 TFile node)
          throws IOException

Copies oldNode to node recursively and updates the tree accordingly. Note that the current selection may get lost.

Throws:

IOException - on any I/O error.

cp_rp

public void cp_rp(TFile oldNode,
                  TFile node)
           throws IOException

Copies oldNode to node recursively preserving its last modification time and updates the tree accordingly. Note that the current selection may get lost.

Throws:

IOException - on any I/O error.

cp

public void cp(@WillClose
               InputStream in,
               TFile node)
        throws IOException

Copies in to node and updates the tree accordingly. Note that the given stream is always closed and that the current selection may get lost.

Throws:

IOException - on any I/O error.

cp

public void cp(TFile oldNode,
               TFile node)
        throws IOException

Copies oldNode to node and updates the tree accordingly. Note that the current selection may get lost.

Throws:

IOException - on any I/O error.

createNewFile

public boolean createNewFile(TFile node)
                      throws IOException

Creates node as a new file in the file system and updates the tree accordingly. If you would like to create a new file with initial content, please use cp(InputStream, TFile) instead. Note that the current selection may get lost.

Returns:

Whether or not the file has been newly created.

Throws:

IOException - on any I/O error.

fireTreeNodesChanged

protected void fireTreeNodesChanged(TreeModelEvent evt)

This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel. May be used to tell the listeners about a change in the file system.

fireTreeNodesInserted

protected void fireTreeNodesInserted(TreeModelEvent evt)

This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel. May be used to tell the listeners about a change in the file system.

fireTreeNodesRemoved

protected void fireTreeNodesRemoved(TreeModelEvent evt)

This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel. May be used to tell the listeners about a change in the file system.

fireTreeStructureChanged

protected void fireTreeStructureChanged(TreeModelEvent evt)

This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel. May be used to tell the listeners about a change in the file system.

getChild

public TFile getChild(Object parent,
                      int index)

Specified by:

getChild in interface TreeModel

getChildCount

public int getChildCount(Object parent)

Specified by:

getChildCount in interface TreeModel

getIndexOfChild

public int getIndexOfChild(Object parent,
                           Object child)

Specified by:

getIndexOfChild in interface TreeModel

getRoot

public TFile getRoot()

Specified by:

getRoot in interface TreeModel

isLeaf

public boolean isLeaf(Object node)

Specified by:

isLeaf in interface TreeModel

mkdir

public void mkdir(TFile node,
                  boolean recursive)
           throws IOException

Ensures that node exists as a (virtual) directory in the (federated) file system and updates the tree accordingly. Note that the current selection may get lost.

Parameters:

recursive - whether or not any missing ancestor directories shall get created if required.

Throws:

IOException - on any I/O error.

mv

public void mv(TFile oldNode,
               TFile node)
        throws IOException

Moves oldNode to node and updates the tree accordingly. Note that the current selection may get lost.

Throws:

IOException - on any I/O error.

nodeChanged

public void nodeChanged(TFile node)

Updates the given node in the tree. This method calls TreeModelListener.treeNodesChanged(TreeModelEvent) on all listeners of this TreeModel.

nodeInserted

public void nodeInserted(TFile node)

Inserts the given node in the tree. If node already exists, nothing happens. This method calls TreeModelListener.treeNodesInserted(TreeModelEvent) on all listeners of this TreeModel.

nodeInsertedOrStructureChanged

public void nodeInsertedOrStructureChanged(TFile node)

Inserts the given node in the tree or reloads the tree structure for the given node if it already exists. This method calls TreeModelListener.treeNodesInserted(TreeModelEvent) on all listeners of this TreeModel.

nodeRemoved

public void nodeRemoved(TFile node)

Removes the given node from the tree. This method calls TreeModelListener.treeNodesRemoved(TreeModelEvent) on all listeners of this TreeModel.

refresh

public void refresh()

Refreshes the tree structure for the entire tree. This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel.

refresh

public final void refresh(TFile node)

Alias for structureChanged(TFile).

removeTreeModelListener

public void removeTreeModelListener(TreeModelListener l)

Removes a listener from this model.

Specified by:

removeTreeModelListener in interface TreeModel

Parameters:

l - The listener to remove.

rm_r

public void rm_r(TFile node)
          throws IOException

Deletes the file or (probably not empty) directory node and updates the tree accordingly. Note that the current selection may get lost.

Throws:

IOException - on any I/O error.

rm

public void rm(TFile node)
        throws IOException

Deletes the file or empty directory node and updates the tree accordingly. Note that the current selection may get lost.

Throws:

IOException - on any I/O error.

structureChanged

public void structureChanged(TFile node)

Reloads the tree structure for the given node. This method calls TreeModelListener.treeStructureChanged(TreeModelEvent) on all listeners of this TreeModel.

valueForPathChanged

public void valueForPathChanged(TreePath path,
                                Object newValue)

Specified by:

valueForPathChanged in interface TreeModel