org.ametys.plugins.repository.metadata

Interface Folder

All Known Subinterfaces:

ModifiableFolder

All Known Implementing Classes:

JCRFolder

public interface Folder

Interface representing a folder.

Method Summary

Modifier and Type	Method and Description
File	getFile(String fileName) Returns the file with the specified name.
Collection<? extends File>	getFiles() Returns a Collection containing all files of this folder.
Folder	getFolder(String folderName) Returns the folder with the specified name.
Collection<? extends Folder>	getFolders() Returns a Collection containing all subfolders of this folder.
String	getName() Returns the folder name.
boolean	hasFile(String fileName) Tests the existence of a file.

Method Detail

getName

String getName()
        throws AmetysRepositoryException

Returns the folder name.

Returns:

the folder name.

Throws:

AmetysRepositoryException - if an error occurs.

getFolders

Collection<? extends Folder> getFolders()
                                 throws AmetysRepositoryException

Returns a Collection containing all subfolders of this folder.

Returns:

a Collection containing all subfolders of this folder.

Throws:

AmetysRepositoryException - if an error occurs

getFolder

Folder getFolder(String folderName)
          throws UnknownMetadataException,
                 AmetysRepositoryException

Returns the folder with the specified name.

Parameters:

folderName - the name of the folder.

Returns:

the folder with the specified name.

Throws:

UnknownMetadataException - if the folder does not exist.

AmetysRepositoryException - if an error occurs.

getFiles

Collection<? extends File> getFiles()
                             throws AmetysRepositoryException

Returns a Collection containing all files of this folder.

Returns:

a Collection containing all files of this folder.

Throws:

AmetysRepositoryException - if an error occurs.

hasFile

boolean hasFile(String fileName)
         throws AmetysRepositoryException

Tests the existence of a file.

Parameters:

fileName - the name of the file.

Returns:

true if the specified file exists in this folder.

Throws:

AmetysRepositoryException - if an error occurs.

getFile

File getFile(String fileName)
      throws UnknownMetadataException,
             AmetysRepositoryException

Returns the file with the specified name.

Parameters:

fileName - the name of the file.

Returns:

the file with the specified name.

Throws:

UnknownMetadataException - if the folder does not exist.

AmetysRepositoryException - if an error occurs.