org.trianacode.taskgraph.util

Class Listing

java.lang.Object

org.trianacode.taskgraph.util.Listing

public class Listing
extends java.lang.Object

Class Description Here...

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIR
static int	FILE

Constructor Summary

Constructors

Constructor and Description
Listing() creates a listing with a 10 elements
Listing(int i) creates a listing with a specified number of elements.

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(java.lang.Object fileOrListing) adds an element to the list.
java.lang.String[]	convertToStrings() Recurses through the Listing and returns an array of strings containing each element within the Listing.
java.lang.Object	elementAt(int i)
java.lang.String	findAFile() Finds the first available file i.e.
Listing	justDirStructure() A listing with all of the files removed, just the directory structure remains.
Listing	justDirStructure(java.lang.String search) A listing with all of the files removed, just the directory structure remains.
Listing	justFileList() A listing with all of the directories removed.
Listing	justFileList(java.lang.String search) A listing with all of the directories removed.
boolean	matched(java.lang.String item, java.lang.String matchStr) matches the file to the given matching string.
Listing	pickOutMatching(java.lang.String search) A listing with all of the directories removed.
Listing	recurseAndEdit(int mode, java.lang.String s) Recurses this list and returns and editted version i.e.
int	size()
java.lang.String	toString()
java.lang.String	toString(boolean longFormat)
java.lang.String[]	toStrings(boolean longFormat)

Methods inherited from class java.lang.Object

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

Field Detail

DIR

public static int DIR

FILE

public static int FILE

Constructor Detail

Listing

public Listing()

creates a listing with a 10 elements

Listing

public Listing(int i)

creates a listing with a specified number of elements.

Method Detail

size

public int size()

Returns:

the number of files/directories in this lsiting.

addElement

public void addElement(java.lang.Object fileOrListing)

adds an element to the list.

justDirStructure

public Listing justDirStructure()

A listing with all of the files removed, just the directory structure remains. Use one of the toString methods to have formatted output.

justFileList

public Listing justFileList()

A listing with all of the directories removed.

justDirStructure

public Listing justDirStructure(java.lang.String search)

A listing with all of the files removed, just the directory structure remains. Use one of the toString methods to have formatted output.

justFileList

public Listing justFileList(java.lang.String search)

A listing with all of the directories removed.

pickOutMatching

public Listing pickOutMatching(java.lang.String search)

A listing with all of the directories removed.

findAFile

public java.lang.String findAFile()

Finds the first available file i.e. non Listing = directory in this Listing. Recursion again!

recurseAndEdit

public Listing recurseAndEdit(int mode,
                     java.lang.String s)

Recurses this list and returns and editted version i.e. a refined search on specific file name matches or Listings with directory occurances removed.

matched

public boolean matched(java.lang.String item,
              java.lang.String matchStr)

matches the file to the given matching string. The matching String can contain waitForWilcards etc and this unction will match accordingly.

elementAt

public java.lang.Object elementAt(int i)

Returns:

the ith element within the Listing. This could be a File or a Listing.

toStrings

public java.lang.String[] toStrings(boolean longFormat)

Returns:

a listing as a set of Strings. If longFormat is true then the format of the listing will be in long format (i.e. with file details etc).

convertToStrings

public java.lang.String[] convertToStrings()

Recurses through the Listing and returns an array of strings containing each element within the Listing.

toString

public java.lang.String toString(boolean longFormat)

Returns:

a listing as a string with carriage returns between each item. If longFormat is true then the format of the listing will be in long format (i.e. with file details etc).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a listing as a strings not in long format.