blob: 1aefb1238305c9188f5bce9cf86c3ff9f4cf56c9 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.core.diff;
/**
* An objects that visits diffs in a diff tree.
* <p>
* Usage:
* </p>
*
* <pre>
* class Visitor implements IDiffVisitor {
* public boolean visit(IDiffNode diff) {
* switch (diff.getKind()) {
* case IResourceDelta.ADDED :
* // handle added resource
* break;
* case IResourceDelta.REMOVED :
* // handle removed resource
* break;
* case IResourceDelta.CHANGED :
* // handle changed resource
* break;
* }
* return true;
* }
* }
* IDiffTree tree = ...;
* tree.accept(new Visitor());
* </pre>
* <p>
* Clients may implement this interface.
* </p>
*
* @see IDiffTree#accept(org.eclipse.core.runtime.IPath, IDiffVisitor, int)
*
* @since 3.2
*/
public interface IDiffVisitor {
/**
* Visits the given diff.
* @param diff the diff being visited
* @return <code>true</code> if the diff's children should
* be visited; <code>false</code> if they should be skipped.
*/
public boolean visit(IDiff diff);
}