001    /*
002     * Copyright (C) 2010 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    
020    package org.crsh.vfs.spi;
021    
022    import java.io.IOException;
023    import java.net.URL;
024    
025    /**
026     * A driver.
027     *
028     * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
029     * @version $Revision$
030     * @param <H> the handle generic type
031     */
032    public interface FSDriver<H> {
033    
034      /**
035       * Returns the root handle.
036       *
037       * @return the root handle
038       * @throws IOException any io exception
039       */
040      H root() throws IOException;
041    
042      String name(H handle) throws IOException;
043    
044      boolean isDir(H handle) throws IOException;
045    
046      H child(H handle, String name) throws IOException;
047    
048      Iterable<H> children(H handle) throws IOException;
049    
050      URL toURL(H handle) throws IOException;
051    
052    }