KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > emf > common > util > TreeIterator


1 /**
2  * <copyright>
3  *
4  * Copyright (c) 2002-2004 IBM Corporation and others.
5  * All rights reserved. This program and the accompanying materials
6  * are made available under the terms of the Eclipse Public License v1.0
7  * which accompanies this distribution, and is available at
8  * http://www.eclipse.org/legal/epl-v10.html
9  *
10  * Contributors:
11  * IBM - Initial API and implementation
12  *
13  * </copyright>
14  *
15  * $Id: TreeIterator.java,v 1.2 2005/06/08 06:19:08 nickb Exp $
16  */
17 package org.eclipse.emf.common.util;
18
19
20 import java.util.Iterator JavaDoc;
21
22
23 /**
24  * A mechanism for iterating over all the nodes of a tree;
25  * it provides the capability to {@link #prune prune} the iteration so that all descendants of a particular node are skipped.
26  */
27 public interface TreeIterator extends Iterator JavaDoc
28 {
29   /**
30    * Prunes the iterator so that it skips over all the nodes below the most recent result of calling {@link #next next()}.
31    */
32   void prune();
33 }
34
Popular Tags