001/*
002 * Syncany, www.syncany.org
003 * Copyright (C) 2011-2016 Philipp C. Heckel <philipp.heckel@gmail.com>
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU General Public License as published by
007 * the Free Software Foundation, either version 3 of the License, or
008 * (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU General Public License for more details.
014 *
015 * You should have received a copy of the GNU General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018package org.syncany.plugins.transfer.features;
019
020import org.syncany.plugins.transfer.TransferManager;
021import org.syncany.plugins.transfer.TransferManagerFactory;
022
023/**
024 * Feature transfer managers extend the functionality of regular {@link TransferManager TransferManagers}
025 * by adding special behavior (such as path awareness, transaction awareness or retriability).
026 * 
027 * <p>A feature transfer manager is typically instantiated by the {@link TransferManagerFactory} and is 
028 * wrapped around the original plugin transfer manager. Its methods always call the underlying (or 
029 * original) transfer manager or perform the actual action.  
030 * 
031 * <p>Each feature transfer manager <b>must</b> have the following constructor signature, in this example
032 * for the the <code>PathAware</code> feature:
033 * 
034 * <pre>
035 *  public PathAwareFeatureTransferManager(TransferManager originalTransferManager, 
036 *     ransferManager underlyingTransferManager, Config config, PathAware pathAwareAnnotation);
037 * </pre>
038 * 
039 * @see Feature
040 * @see FeatureExtension
041 * @author Philipp C. Heckel (philipp.heckel@gmail.com)
042 */
043public interface FeatureTransferManager extends TransferManager {
044        // Marker interface
045}