ParseNodeIterator.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 other free and open source software ("FOSS") 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.parsing.xpath;

import java.util.Iterator;
import java.util.NoSuchElementException;

import com.aptana.ide.parsing.nodes.IParseNode;

/**
 * @author Kevin Lindsey
 */
public abstract class ParseNodeIterator implements Iterator<Object>
{
	private IParseNode _node;

	/**
	 * ParseNodeIterator
	 * 
	 * @param node
	 */
	public ParseNodeIterator(IParseNode node)
	{
		this._node = this.getFirstNode(node);
	}

	/**
	 * @see java.util.Iterator#remove()
	 */
	public void remove()
	{
		throw new UnsupportedOperationException();
	}

	/**
	 * @see java.util.Iterator#hasNext()
	 */
	public boolean hasNext()
	{
		return (this._node != null);
	}

	/**
	 * @see java.util.Iterator#next()
	 */
	public Object next()
	{
		IParseNode result = _node;

		if (this._node == null)
		{
			throw new NoSuchElementException();
		}
		else
		{
			this._node = this.getNextNode(this._node);
		}

		// System.out.println("next = " + result.getName() + ", " + ((IParseNode) result).getSource());

		return result;
	}

	/**
	 * getFirstNode
	 * 
	 * @param node
	 * @return IParseNode
	 */
	protected abstract IParseNode getFirstNode(IParseNode node);

	/**
	 * getNextNode
	 * 
	 * @param node
	 * @return IParseNode
	 */
	protected abstract IParseNode getNextNode(IParseNode node);
}