de.schlichtherle.truezip.file.swing
Class TFileTreeModel

java.lang.Object
  de.schlichtherle.truezip.file.swing.TFileTreeModel

All Implemented Interfaces:

TreeModel

@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
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

cache

private final Map<TFile,TFile[]> cache

Used to cache the contents of directories. Maps TFile -> TFile[] instances.

root

@CheckForNull
private final TFile root

filter

@CheckForNull
private final FileFilter filter

comparator

private final Comparator<? super TFile> comparator

A comparator for TFile or super classes.

listeners

private final EventListenerList listeners

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.

getRoot

public TFile getRoot()

Specified by:

getRoot in interface TreeModel

getChild

@Nullable
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

isLeaf

public boolean isLeaf(Object node)

Specified by:

isLeaf in interface TreeModel

valueForPathChanged

public void valueForPathChanged(TreePath path,
                                Object newValue)

Specified by:

valueForPathChanged in interface TreeModel

getIndexOfChild

public int getIndexOfChild(Object parent,
                           Object child)

Specified by:

getIndexOfChild in interface TreeModel

getChildren

@Nullable
private TFile[] getChildren(TFile parent)

newTreePath

@Nullable
TreePath newTreePath(TFile node)

Returns a new TreePath for the given node or null if node is not part of this file tree or is null.

newPath

@Nullable
private TFile[] newPath(TFile node)

Returns an array of TFile objects indicating the path from the root to the given node.

Parameters:

node - The TFile object to get the path for.

Returns:

An array of TFile objects, suitable as a constructor argument for TreePath or null if node is not part of this file tree or is null.

newPath

@Nullable
private TFile[] newPath(@CheckForNull
                                 TFile node,
                                 int level)

createNewFile

public boolean createNewFile(TFile node)
                      throws IOException

Creates node as a new file in the file system and updates the tree accordingly. However, the current selection may get lost. If you would like to create a new file with initial content, please use copyFrom(de.schlichtherle.truezip.file.TFile, InputStream).

Returns:

Whether or not the file has been newly created.

Throws:

IOException - If an I/O error occurs.

mkdir

public boolean mkdir(TFile node)

Creates node as a new directory and updates the tree accordingly. However, the current selection may get lost.

Returns:

Whether or not the file has been newly created.

Throws:

IOException - If an I/O error occurs.

mkdirs

public boolean mkdirs(TFile node)

Creates node as a new directory, including all parents, and updates the tree accordingly. However, the current selection may get lost.

Returns:

Whether or not the file has been newly created.

Throws:

IOException - If an I/O error occurs.

copyFrom

public boolean copyFrom(TFile node,
                        InputStream in)

Creates node as a new file with the contents read from in and updates the tree accordingly. However, the current selection may get lost. Note that the given stream is always closed.

Returns:

Whether or not the file has been newly created.

Throws:

IOException - If an I/O error occurs.

copyTo

public boolean copyTo(TFile oldNode,
                      TFile node)

Copies oldNode to node and updates the tree accordingly. However, the current selection may get lost.

Returns:

Whether or not the file has been successfully renamed.

copyAllTo

public boolean copyAllTo(TFile oldNode,
                         TFile node)

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

Returns:

Whether or not the file has been successfully renamed.

archiveCopyTo

public boolean archiveCopyTo(TFile oldNode,
                             TFile node)

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

Returns:

Whether or not the file has been successfully renamed.

archiveCopyAllTo

public boolean archiveCopyAllTo(TFile oldNode,
                                TFile node)

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

Returns:

Whether or not the file has been successfully renamed.

renameTo

public boolean renameTo(TFile oldNode,
                        TFile newNode)

Renames oldNode to newNode and updates the tree accordingly. However, the current selection may get lost.

Returns:

Whether or not the file has been successfully renamed.

delete

public boolean delete(TFile node)

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

Returns:

Whether or not the file or directory has been successfully deleted.

Throws:

IOException - If an I/O error occurs.

deleteAll

public boolean deleteAll(TFile node)

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

Returns:

Whether or not the file or directory has been successfully deleted.

Throws:

IOException - If an I/O error occurs.

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.

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.

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.

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).

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.

forget

void forget(TFile node)

Clears the internal cache associated with node and all of its children.

forget

private void forget(@Nullable
                    TFile node,
                    boolean childrenToo)

Clears the internal cache associated with node.

Parameters:

childrenToo - If and only if true, the internal cache for all children is cleared, too.

addTreeModelListener

public void addTreeModelListener(TreeModelListener l)

Adds a listener to this model.

Specified by:

addTreeModelListener in interface TreeModel

Parameters:

l - The listener to add.

removeTreeModelListener

public void removeTreeModelListener(TreeModelListener l)

Removes a listener from this model.

Specified by:

removeTreeModelListener in interface TreeModel

Parameters:

l - The listener to remove.

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.