PassthroughFileFactory.java

/**
 * This file is part of Waarp Project.
 * 
 * Copyright 2009, Frederic Bregier, and individual contributors by the @author tags. See the
 * COPYRIGHT.txt in the distribution for a full listing of individual contributors.
 * 
 * All Waarp Project 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.
 * 
 * Waarp 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 Waarp . If not, see
 * <http://www.gnu.org/licenses/>.
 */
package org.waarp.common.file.passthrough;

/**
 * This interface is a factory for PassthroughFile.
 * 
 * @author Frederic Bregier
 * 
 */
public interface PassthroughFileFactory {

    /**
     * 
     * @param pbfi
     *            the {@link PassthroughBasedFileImpl}
     * @return the associated {@link PassthroughFile}
     * @throws PassthroughException
     */
    public PassthroughFile create(PassthroughBasedFileImpl pbfi) throws PassthroughException;

    /**
     * 
     * @param dir
     *            Base directory (may be null)
     * @param path
     *            relative or absolute path (may be null)
     * @return the associated {@link PassthroughFile}
     * @throws PassthroughException
     */
    public PassthroughFile create(PassthroughFile dir, String path) throws PassthroughException;
}