org.eclipse.xtext.nodemodel.BidiTreeIterable Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2010 itemis AG (http://www.itemis.eu) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/
package org.eclipse.xtext.nodemodel;

/**
 * An iterable over a tree structure that is capable of being iterated 
 * in both directions - forwards and backwards. The {@link BidiTreeIterator tree iterator}
 * returned by {@link #iterator()} is capable to prune some parts of the tree
 * if clients are not interested in descending into them.
 * @author Sebastian Zarnekow - Initial contribution and API
 */
public interface BidiTreeIterable extends BidiIterable {

	/**
	 * Returns a tree iterator that can be used forwards and backwards.
	 * @return an iterator. Never returns null.
	 */
	BidiTreeIterator iterator();
	
	/**
	 * {@inheritDoc}
	 */
	BidiTreeIterable reverse();

}