SubMatchIterator.java

/*******************************************************************************
 * Copyright (c) 2013 Obeo.
 * 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
 * 
 * Contributors:
 *     Obeo - initial API and implementation
 *******************************************************************************/
package org.eclipse.emf.compare.internal;

import java.util.Iterator;

import org.eclipse.emf.common.util.AbstractTreeIterator;
import org.eclipse.emf.compare.Match;

/**
 * A custom TreeIterator that will iterate over the Match->submatch tree.
 * 
 * @author <a href="mailto:laurent.goubet@obeo.fr">Laurent Goubet</a>
 */
public class SubMatchIterator extends AbstractTreeIterator<Match> {
	/** Generated SUID. */
	private static final long serialVersionUID = -1789806135599824529L;

	/**
	 * Constructs an iterator given the root of its tree.
	 * 
	 * @param start
	 *            Starting match of the tree we'll iterate over.
	 */
	public SubMatchIterator(Match start) {
		super(start, false);
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.emf.common.util.AbstractTreeIterator#getChildren(java.lang.Object)
	 */
	@Override
	protected Iterator<? extends Match> getChildren(Object obj) {
		return ((Match)obj).getSubmatches().iterator();
	}
}