SiblingIterator.java

package com.indyforge.twod.engine.graphics.rendering.scenegraph.util.iteration;

import com.indyforge.twod.engine.graphics.rendering.scenegraph.Entity;
import com.indyforge.twod.engine.util.iteration.EmptyIterator;
import com.indyforge.twod.engine.util.iteration.WrappedIterator;

/**
 * This is a sibling iterator implementation.
 * 
 * @author Christopher Probst
 */
public final class SiblingIterator extends WrappedIterator<Entity> {

	/**
	 * Creates a new sibling iterator using the given root. The root parent will
	 * be part of the iteration, too.
	 * 
	 * @param root
	 *            The root entity.
	 */
	public SiblingIterator(Entity root) {
		this(root, true);
	}

	/**
	 * Creates a new sibling iterator using the given root.
	 * 
	 * @param root
	 *            The root entity.
	 * @param includeRootParent
	 *            The include-root-parent flag.
	 */
	public SiblingIterator(Entity root, boolean includeRootParent) {
		super(root.parent() != null ? new ChildIterator(root.parent(),
				includeRootParent) : new EmptyIterator<Entity>());
	}
}