RecursiveDirectoryLister (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

DirectoryLister, LoggingLevelHandler, LoggingSupporter, Stoppable, StoppableWithFeedback

All Known Implementing Classes:

AbstractRecursiveDirectoryLister, FtpDirectoryLister, LocalDirectoryLister, SftpDirectoryLister, SmbDirectoryLister
```
public interface RecursiveDirectoryLister
extends DirectoryLister
```
Interface for recursive directory listers.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getMaxDepth()`	Returns the maximum depth to search (1 = only watch dir, -1 = infinite).
`boolean`	`getRecursive()`	Returns whether to search recursively.
`void`	`setMaxDepth(int value)`	Sets the maximum depth to search (1 = only watch dir, -1 = infinite).
`void`	`setRecursive(boolean value)`	Sets whether to search recursively.

Methods inherited from interface adams.core.io.lister.DirectoryLister
getListDirs, getListFiles, getMaxItems, getRegExp, getSortDescending, getSorting, getWatchDir, hasParentDirectory, isLocal, list, listObjects, newDirectory, newDirectory, setListDirs, setListFiles, setMaxItems, setRegExp, setSortDescending, setSorting, setWatchDir

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled

Methods inherited from interface adams.core.Stoppable
stopExecution

Methods inherited from interface adams.core.StoppableWithFeedback
isStopped

- Method Detail
  - setRecursive
```
void setRecursive(boolean value)
```
    Sets whether to search recursively.
    
    Parameters:
    
    value - true if to search recursively
  - getRecursive
```
boolean getRecursive()
```
    Returns whether to search recursively.
    
    Returns:
    
    true if search is recursively
  - setMaxDepth
```
void setMaxDepth(int value)
```
    Sets the maximum depth to search (1 = only watch dir, -1 = infinite).
    
    Parameters:
    
    value - the maximum depth
  - getMaxDepth
```
int getMaxDepth()
```
    Returns the maximum depth to search (1 = only watch dir, -1 = infinite).
    
    Returns:
    
    the maximum depth