org.fastnate.data.files

Class FsDataFolder

java.lang.Object

org.fastnate.data.files.FsDataFolder

All Implemented Interfaces:

DataFolder

public class FsDataFolder
extends Object
implements DataFolder

Represents a folder from the file system.

Author:

Tobias Liefke

Field Summary

Fields

Modifier and Type	Field and Description
private File	folder The directory from the filesystem

Constructor Summary

Constructors

Constructor and Description
FsDataFolder(File folder)

Method Summary

Modifier and Type	Method and Description
DataFile	findFile(String name) Finds a file in this folder.
DataFolder	findFolder(String name) Finds a sub folder in this folder.
List<FsDataFile>	getFiles() Finds all files inside this folder.
File	getFolder() The directory from the filesystem
List<FsDataFolder>	getFolders() Finds the all sub folders inside this folder.
String	getName() The name of this folder.
DataFolder	getParent() The parent folder of this folder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fastnate.data.files.DataFolder

forAllFiles, forAllFiles, getFolder, getPath

Field Detail

folder

private final File folder

The directory from the filesystem

Constructor Detail

FsDataFolder

@ConstructorProperties(value="folder")
 @Generated(value="lombok")
public FsDataFolder(File folder)

Method Detail

findFile

public DataFile findFile(String name)

Description copied from interface: DataFolder

Finds a file in this folder.

Specified by:

findFile in interface DataFolder

Parameters:

name - the name of the file

Returns:

the file or null if no file with such a name exists

findFolder

public DataFolder findFolder(String name)

Description copied from interface: DataFolder

Finds a sub folder in this folder.

Specified by:

findFolder in interface DataFolder

Parameters:

name - the name of the sub folder

Returns:

the sub folder or null if no folder with such a name exists

getFiles

public List<FsDataFile> getFiles()

Description copied from interface: DataFolder

Finds all files inside this folder. Will not return a file from a sub folder

Specified by:

getFiles in interface DataFolder

Returns:

the files in this folder

getFolders

public List<FsDataFolder> getFolders()

Description copied from interface: DataFolder

Finds the all sub folders inside this folder.

Specified by:

getFolders in interface DataFolder

Returns:

the direct children of this folder

getName

public String getName()

Description copied from interface: DataFolder

The name of this folder.

Specified by:

getName in interface DataFolder

Returns:

the name of this folder, empty or null for the root folder

getParent

public DataFolder getParent()

Description copied from interface: DataFolder

The parent folder of this folder.

Specified by:

getParent in interface DataFolder

Returns:

the parent or null if this folder is the root folder

getFolder

@Generated(value="lombok")
public File getFolder()

The directory from the filesystem