FileSystemAccess.java

//$HeadURL$
/*----------------    FILE HEADER  ------------------------------------------
 This file is part of deegree.
 Copyright (C) 2001-2008 by:
 Department of Geography, University of Bonn
 http://www.giub.uni-bonn.de/deegree/
 lat/lon GmbH
 http://www.lat-lon.de

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.
 This library 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
 Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 Contact:

 Andreas Poth
 lat/lon GmbH
 Aennchenstr. 19
 53177 Bonn
 Germany
 E-Mail: poth@lat-lon.de

 Prof. Dr. Klaus Greve
 Department of Geography
 University of Bonn
 Meckenheimer Allee 166
 53115 Bonn
 Germany
 E-Mail: greve@giub.uni-bonn.de
 ---------------------------------------------------------------------------*/

package org.deegree.igeo.io;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.net.URL;

import org.deegree.igeo.ApplicationContainer;

/**
 * The <code></code> class TODO add class documentation here.
 * 
 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
 * 
 * @author last edited by: $Author$
 * 
 * @version $Revision$, $Date$
 * 
 */
public interface FileSystemAccess {
    
    /**
     * 
     * @param appCont
     */
    void setApplicationContainer( ApplicationContainer<?> appCont);

    /**
     * 
     * @param directory
     * @return list of files and directories contained in passed directory 
     */
    File[] listDirectory(File directory, String ... extension) throws IOException;
    
    /**
     * 
     * @param file
     * @return {@link InputStream} for accessing a file
     * @throws IOException
     */
    InputStream readFile(File file) throws IOException;
    
    /**
     * 
     * @param file
     * @return URL for passed file
     */
    URL getFileURL(String file) throws IOException;
    
    /**
     * writes a file. Content is read from passed {@link Reader}
     * @param file
     * @param contentReader
     * @throws IOException
     */
    void writeFile(File file, Reader contentReader) throws IOException;
    
    /**
     * writes a file. Content is read from passed {@link InputStream}
     * @param file
     * @param contentStream
     * @throws IOException
     */
    void writeFile(File file, InputStream contentStream) throws IOException;
    
    /**
     * deletes a file
     * @param file
     * @throws IOException
     */
    void deleteFile(File file) throws IOException;
    
    /**
     * 
     * @param file
     * @return <code>true</code> if passed file exists
     */
    boolean exists(File file) throws IOException;
}