Copyright (c) 2000, 2009 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
/*******************************************************************************
* Copyright (c) 2000, 2009 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.core.resources;
import org.eclipse.core.runtime.CoreException;
This interface is implemented by objects that visit resource trees.
Usage:
class Visitor implements IResourceVisitor {
public boolean visit(IResource res) {
// your code here
return true;
}
}
IResource root = ...;
root.accept(new Visitor());
Clients may implement this interface.
See Also: - accept.accept(IResourceVisitor)
/**
* This interface is implemented by objects that visit resource trees.
* <p>
* Usage:
* </p>
* <pre>
* class Visitor implements IResourceVisitor {
* public boolean visit(IResource res) {
* // your code here
* return true;
* }
* }
* IResource root = ...;
* root.accept(new Visitor());
* </pre>
* <p>
* Clients may implement this interface.
* </p>
*
* @see IResource#accept(IResourceVisitor)
*/
public interface IResourceVisitor {
Visits the given resource.
Params: - resource – the resource to visit
Throws: - CoreException – if the visit fails for some reason.
Returns: true
if the resource's members should
be visited; false
if they should be skipped
/**
* Visits the given resource.
*
* @param resource the resource to visit
* @return <code>true</code> if the resource's members should
* be visited; <code>false</code> if they should be skipped
* @exception CoreException if the visit fails for some reason.
*/
boolean visit(IResource resource) throws CoreException;
}