org.opencms.util

Class CmsFileUtil.FileWalkState

java.lang.Object

org.opencms.util.CmsFileUtil.FileWalkState

Enclosing class:

CmsFileUtil

public static class CmsFileUtil.FileWalkState
extends java.lang.Object

Data bean which walkFileSystem passes to its callback.

The list of directories is mutable, which can be used by the callback to exclude certain directories.

Constructor Summary

Constructors

Constructor and Description
FileWalkState(java.io.File currentDir, java.util.List<java.io.File> dirs, java.util.List<java.io.File> files) Creates a new file walk state.

Method Summary

Modifier and Type	Method and Description
java.io.File	getCurrentDir() Gets the current directory.
java.util.List<java.io.File>	getDirectories() Gets the list of subdirectories.
java.util.List<java.io.File>	getFiles() Returns the list of files.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileWalkState

public FileWalkState(java.io.File currentDir,
                     java.util.List<java.io.File> dirs,
                     java.util.List<java.io.File> files)

Creates a new file walk state.

Parameters:

currentDir - the current directory

dirs - the list of subdirectories

files - the list of files

Method Detail

getCurrentDir

public java.io.File getCurrentDir()

Gets the current directory.

Returns:

the current directory

getDirectories

public java.util.List<java.io.File> getDirectories()

Gets the list of subdirectories.

Returns:

the list of subdirectories

getFiles

public java.util.List<java.io.File> getFiles()

Returns the list of files.

Returns:

the list of files