SyncEventHandlerAdapter.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain Eclipse Public Licensed code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.syncing.ui.handlers;

import com.aptana.ide.core.io.IConnectionPoint;
import com.aptana.ide.core.io.syncing.VirtualFileSyncPair;
import com.aptana.ide.syncing.core.events.ISyncEventHandler;

/**
 * @author Kevin Sawicki (ksawicki@aptana.com)
 */
public abstract class SyncEventHandlerAdapter implements ISyncEventHandler
{

	/**
	 * @see com.aptana.ide.syncing.core.events.sync.ISyncEventHandler#syncContinue()
	 */
	public boolean syncContinue() {
		// Does nothing by default, subclasses should override
		return true;
	}

	/**
	 * @see com.aptana.ide.syncing.core.events.sync.ISyncEventHandler#syncDone(com.aptana.ide.core.io.syncing.sync.VirtualFileSyncPair)
	 */
	public void syncDone(VirtualFileSyncPair item)
	{
		// Does nothing by default, subclasses should override
	}

	/**
	 * @see com.aptana.ide.syncing.core.events.sync.ISyncEventHandler#syncErrorEvent(com.aptana.ide.core.io.syncing.sync.VirtualFileSyncPair,
	 *      java.lang.Exception)
	 */
	public boolean syncErrorEvent(VirtualFileSyncPair item, Exception e)
	{
		// Does nothing by default, subclasses should override
		return true;
	}

	/**
	 * @see com.aptana.ide.syncing.core.events.sync.ISyncEventHandler#syncEvent(com.aptana.ide.core.io.syncing.sync.VirtualFileSyncPair,
	 *      int, int)
	 */
	public boolean syncEvent(VirtualFileSyncPair item, int index, int totalItems)
	{
		// Does nothing by default, subclasses should override
		return true;
	}

	/**
	 * @see com.aptana.ide.syncing.core.events.sync.ISyncEventHandler#syncTransferring(com.aptana.ide.core.io.syncing.sync.VirtualFileSyncPair,
	 *      long)
	 */
	public void syncTransferring(VirtualFileSyncPair item, long bytes)
	{
		// Does nothing by default, subclasses should override
	}

	/**
	 * @see com.aptana.ide.core.io.IConnectionPointEventHandler#getFilesEvent(com.aptana.ide.core.io.IVirtualFileManager,
	 *      java.lang.String)
	 */
	public boolean getFilesEvent(IConnectionPoint manager, String path)
	{
		// Does nothing by default, subclasses should override
		return true;
	}

}