org.pfsw.file

Class TableOfContents

java.lang.Object

org.pfsw.file.TableOfContents

public class TableOfContents
extends java.lang.Object

An instance of this class contains a list of DirectoryContents objects. The purpose is to hold in one object all directory and file information from either an archive (zip/jar) or a base directory (e.g. "/usr/apps/conf").
To represent both types in a common information structure allows to present or analyze the content information in a common way.

Constructor Summary

Constructors

Constructor and Description
TableOfContents(java.lang.String name) Initialize the new instance with default values.

Method Summary

Modifier and Type	Method and Description
void	add(DirectoryContents dir) Adds the given directory contents holder to the table of contents
DirectoryContents	dirContentAt(int index) Returns the DirectoryContents entry at the specified index.
java.lang.String	dirNameAt(int index) Returns the name of the directory entry at the specified index.
FileInfo[]	filesAt(int index) Returns the file info objects of the directory entry at the specified index.
java.util.List<DirectoryContents>	findSubDirsOf(java.lang.String baseDir) Returns all sub-directories under the given base directory.
protected java.lang.String	getContainerName()
DirectoryContents[]	getDirectories() Returns all contained directories
protected java.util.List<DirectoryContents>	getDirInfos()
java.lang.String	getName() Returns the name of the container this table of contents belongs to
protected java.lang.String	inspectString() Returns a display string for an inspector.
protected void	setContainerName(java.lang.String newValue)
protected void	setDirInfos(java.util.List<DirectoryContents> newValue)
int	size() Returns the number of directory entries in this table of contents

Methods inherited from class java.lang.Object

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

Constructor Detail

TableOfContents

public TableOfContents(java.lang.String name)

Initialize the new instance with default values.

Method Detail

getName

public java.lang.String getName()

Returns the name of the container this table of contents belongs to

add

public void add(DirectoryContents dir)

Adds the given directory contents holder to the table of contents

getDirectories

public DirectoryContents[] getDirectories()

Returns all contained directories

size

public int size()

Returns the number of directory entries in this table of contents

dirContentAt

public DirectoryContents dirContentAt(int index)

Returns the DirectoryContents entry at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the index is not valid

dirNameAt

public java.lang.String dirNameAt(int index)

Returns the name of the directory entry at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the index is not valid

filesAt

public FileInfo[] filesAt(int index)

Returns the file info objects of the directory entry at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the index is not valid

findSubDirsOf

public java.util.List<DirectoryContents> findSubDirsOf(java.lang.String baseDir)

Returns all sub-directories under the given base directory. The returned directories do not contain the baseDir path and no leading slash.

Parameters:

baseDir - The directory under which to look for the sub directories.

Returns:

A list of the found directories (maybe empty, but never null).

inspectString

protected java.lang.String inspectString()

Returns a display string for an inspector. Active JOI support !

getContainerName

protected java.lang.String getContainerName()

setContainerName

protected void setContainerName(java.lang.String newValue)

getDirInfos

protected java.util.List<DirectoryContents> getDirInfos()

setDirInfos

protected void setDirInfos(java.util.List<DirectoryContents> newValue)