ReadAfterWriteConsistentFeatureExtension.java

/*
 * Syncany, www.syncany.org
 * Copyright (C) 2011-2015 Philipp C. Heckel <philipp.heckel@gmail.com>
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */
package org.syncany.plugins.transfer.features;

import org.syncany.plugins.transfer.StorageException;
import org.syncany.plugins.transfer.TransferManager;
import org.syncany.plugins.transfer.files.RemoteFile;

/**
 * The read write consistent feature extension must be defined in the {@link ReadAfterWriteConsistent}
 * feature in order to extend a {@link TransferManager} that was marked as 'read write consistent'
 * with the required methods to verify if a file exists on the remote side.
 *
 * @author Christian Roth <christian.roth@port17.de>
 */
public interface ReadAfterWriteConsistentFeatureExtension extends FeatureExtension {
	/**
	 * Check if a file on the remote side already exists.
	 *
	 * @param remoteFile The file to look up
	 * @return True if the file exists and is accessible and false otherwise
	 * @throws StorageException Thrown if an error occurred
	 */
	boolean exists(RemoteFile remoteFile) throws StorageException;
}