org.gvsig.tools.folders

Interface FoldersManager

All Superinterfaces:

Iterable<String>

All Known Implementing Classes:

DefaultFoldersManager

public interface FoldersManager
extends Iterable<String>

This class allows to keep a registry of folders associating to each folder a name, as well as to manage the location and access to the temporary files.

Method Summary

Modifier and Type	Method and Description
void	cleanTemporaryFiles() Remove al files in the temporary folder.
File	createTemporaryFile(String basename, byte[] data) Creates a temporary file with a the provided name and data.
File	createTemporaryFile(String basename, String data)
File	createTemporaryFolder() Force the creation of the temporary folder.
File	get(String id) Retrieves the file associated with the indicated identifier.
File	get(String id, File defaultValue) Retrieves the file associated with the indicated identifier.
File	getTemporaryFile(String... pathComponents) Return a file with the specified relative path to the temporary folder.
File	getTemporaryFolder() Return the file associated to the temporary folder.
File	getUniqueTemporaryFile(String... pathComponents) Return a unique file with the specified relative path to the temporary folder.
boolean	isEmpty() Returns true if there is no stored file.
Iterator<String>	iterator() Returns an iterator over the identifiers of the stored files.
void	set(String id, File file) Stores the file with the indicated identifier.
void	setTemporaryFolder(File folder) Set the file associated to the temporary folder.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getTemporaryFolder

File getTemporaryFolder()

Return the file associated to the temporary folder. The file can't exits.

Returns:

the temporary folder.

setTemporaryFolder

void setTemporaryFolder(File folder)

Set the file associated to the temporary folder.

Parameters:

folder -

cleanTemporaryFiles

void cleanTemporaryFiles()

Remove al files in the temporary folder.

createTemporaryFolder

File createTemporaryFolder()

Force the creation of the temporary folder.

Returns:

the file associated to the temporary folder

getTemporaryFile

File getTemporaryFile(String... pathComponents)

Return a file with the specified relative path to the temporary folder. The file will be deleted when the application exits.

Parameters:

pathComponents -

Returns:

the requested absolute file in temporary folder.

getUniqueTemporaryFile

File getUniqueTemporaryFile(String... pathComponents)

Return a unique file with the specified relative path to the temporary folder. The base name of the file is modified to be unique. The file will be deleted when the application exits.

Parameters:

pathComponents -

Returns:

the requested absolute file in temporary folder.

createTemporaryFile

File createTemporaryFile(String basename,
                         byte[] data)
                  throws IOException

Creates a temporary file with a the provided name and data. The file will be automatically deleted when the application exits.

Parameters:

basename - of the temporary file to create

data - The data to store in the file

Returns:

the File

Throws:

IOException

createTemporaryFile

File createTemporaryFile(String basename,
                         String data)
                  throws IOException

Throws:

IOException

set

void set(String id,
         File file)

Stores the file with the indicated identifier.

Parameters:

id -

file -

get

File get(String id)

Retrieves the file associated with the indicated identifier. If there is not a file associated with the identifier, return null.

Parameters:

id -

Returns:

get

File get(String id,
         File defaultValue)

Retrieves the file associated with the indicated identifier. If there is no file associated with the identifier, return he default value.

Parameters:

id -

defaultValue -

Returns:

iterator

Iterator<String> iterator()

Returns an iterator over the identifiers of the stored files.

Specified by:

iterator in interface Iterable<String>

Returns:

isEmpty

boolean isEmpty()

Returns true if there is no stored file.

Returns: