dutils.digger
Class Digger

java.lang.Object
  |
  +--dutils.digger.Digger

Direct Known Subclasses:

ArchiveDigger, DirectoryDigger

public abstract class Digger

extends java.lang.Object

An abstract class for a generic 'digger' class.
Instances of Digger can search all sorts of locations (for example, directories or archives).
All search data (like what to search for) is contained in a SearchData object.

Version:

1.0

Author:

Daniel Or

Constructor Summary

Digger(dutils.digger.SearchData searchData)
Constructor for Digger.

Method Summary

abstract java.lang.String[]	dig() performs a dig (search) operation and returns results as a String array where each String describes an absolute location of a matching result. In the context of files, an absolute result is a file's full path.
abstract java.lang.String[]	digRelative() performs a dig (search) operation and returns results as a String array where each String describes a relative location of a matching result (relative to this digger search start point). In the context of files, a relative result is a file's relative path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Digger

public Digger(dutils.digger.SearchData searchData)

Constructor for Digger.

Parameters:

searchData - a SearchData object.

Method Detail

dig

public abstract java.lang.String[] dig()

performs a dig (search) operation and returns results as a String array where each String describes an absolute location of a matching result.
In the context of files, an absolute result is a file's full path.

Returns:

String[] containing search results.

digRelative

public abstract java.lang.String[] digRelative()

performs a dig (search) operation and returns results as a String array where each String describes a relative location of a matching result (relative to this digger search start point).
In the context of files, a relative result is a file's relative path.

Returns:

String[] containing search results.