net.sourceforge.atunes.kernel.modules.repository.model
Class Folder

java.lang.Object
  net.sourceforge.atunes.kernel.modules.repository.model.Folder

All Implemented Interfaces:

java.io.Serializable, TreeObject

public class Folder
extends java.lang.Object
implements java.io.Serializable, TreeObject

This class represents a folder with a name, and a list of files and more folders.

Author:

fleax

See Also:

Serialized Form

Constructor Summary

Folder(java.lang.String name)
Constructor.

Method Summary

void	addFile(AudioFile file) Adds a file to this folder.
void	addFolder(Folder f) Adds a folder as child of this folder.
boolean	containsFolder(java.lang.String folderName) Returns true if folder contains a folder with given name.
java.util.List<AudioFile>	getAudioFiles() Gets the audio files.
java.util.List<AudioObject>	getAudioObjects() Returns a list of songs in this folder and in children folders.
java.util.List<AudioFile>	getFiles() Returns files in this folder.
Folder	getFolder(java.lang.String folderName) Returns a child folder given a folder name.
java.util.Map<java.lang.String,Folder>	getFolders() Returns all children folders.
java.lang.String	getName() Returns the name of this folder.
Folder	getParentFolder() Gets the parent folder.
boolean	isEmpty() Returns true if folder is empty (contains neither files nor folders).
void	removeFile(AudioFile file) Removes a file from this folder.
void	removeFolder(Folder f) Removes a folder from this folder.
void	setName(java.lang.String name) Sets the name of this folder.
java.lang.String	toString() String representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Folder

public Folder(java.lang.String name)

Constructor.

Parameters:

name - the name

Method Detail

addFile

public void addFile(AudioFile file)

Adds a file to this folder.

Parameters:

file - the file

addFolder

public void addFolder(Folder f)

Adds a folder as child of this folder.

Parameters:

f - the f

containsFolder

public boolean containsFolder(java.lang.String folderName)

Returns true if folder contains a folder with given name.

Parameters:

folderName - the folder name

Returns:

true, if contains folder

getAudioFiles

public java.util.List<AudioFile> getAudioFiles()

Gets the audio files.

Returns:

the audio files

getAudioObjects

public java.util.List<AudioObject> getAudioObjects()

Returns a list of songs in this folder and in children folders.

Specified by:

getAudioObjects in interface TreeObject

Returns:

the audio objects

getFiles

public java.util.List<AudioFile> getFiles()

Returns files in this folder.

Returns:

the files

getFolder

public Folder getFolder(java.lang.String folderName)

Returns a child folder given a folder name.

Parameters:

folderName - the folder name

Returns:

the folder

getFolders

public java.util.Map<java.lang.String,Folder> getFolders()

Returns all children folders.

Returns:

the folders

getName

public java.lang.String getName()

Returns the name of this folder.

Returns:

the name

getParentFolder

public Folder getParentFolder()

Gets the parent folder.

Returns:

the parentFolder

isEmpty

public boolean isEmpty()

Returns true if folder is empty (contains neither files nor folders).

Returns:

true, if checks if is empty

removeFile

public void removeFile(AudioFile file)

Removes a file from this folder.

Parameters:

file - the file

removeFolder

public void removeFolder(Folder f)

Removes a folder from this folder.

Parameters:

f - the f

setName

public void setName(java.lang.String name)

Sets the name of this folder.

Parameters:

name - the name

toString

public java.lang.String toString()

String representation.

Overrides:

toString in class java.lang.Object

Returns:

the string