Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.folders;

import java.io.File;

import java.io.IOException;

import java.util.Iterator;

import java.util.Map;

/**

 * 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.

 * 

 * @author gvSIG association

 */

public interface FoldersManager extends Iterable<String> {

    /**

     * Return the file associated to the temporary folder.

     * The file can't exits.

     * 

     * @return the temporary folder. 

     */

    public File getTemporaryFolder();

    /**

     * Set the file associated to the temporary folder.

     * 

     * @param folder 

     */

    public void setTemporaryFolder(File folder);

    /**

     * Remove al files in the temporary folder.

     */

    public void cleanTemporaryFiles();

    /**

     * Force the creation of the temporary folder.

     * 

     * @return the file associated to the temporary folder

     */

    public File createTemporaryFolder();

    /**

     * Return a file with the specified relative path to the 

     * temporary folder.

     * The file will be deleted when the application exits. 

     * 

     * @param pathComponents

     * @return the requested absolute file in temporary folder.

     */

    public File getTemporaryFile(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. 

     * 

     * @param pathComponents

     * @return the requested absolute file in temporary folder.

     */

    public File getUniqueTemporaryFile(String... pathComponents);

    /**

     * Creates a temporary file with a the provided name and data. 

     * The file will be automatically deleted when the application exits. 

     * 

     * @param basename of the temporary file to create

     * @param data The data to store in the file

     * @return the File 

     * @throws java.io.IOException

     */

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

    public File createTemporaryFile(String basename, String data) throws IOException ;

    /**

     * Stores the file with the indicated identifier.

     * 

     * @param id

     * @param file 

     */

    public void set(String id, File file);

    /**

     * Retrieves the file associated with the indicated identifier.

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

     * 

     * @param id

     * @return 

     */

    public File get(String id);

    /**

     * Retrieves the file associated with the indicated identifier.

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

     * 

     * @param id

     * @param defaultValue

     * @return 

     */

    public File get(String id, File defaultValue);

    public File getHome();

    /**

     * Returns an iterator over the identifiers of the stored files.

     * 

     * @return 

     */

    @Override

    public Iterator<String> iterator();

    /**

     * Returns true if there is no stored file.

     * 

     * @return 

     */

    public boolean isEmpty();

    public File getLastPath(String pathId, File defaultValue);

    public Iterator<Map.Entry<String,File>> lastPathsIterator();

    public void setLastPath(String pathId, File value);

}