ScanningMode.java

/**
 * Copyright (C) 2006-2017 INRIA and contributors
 * Spoon - http://spoon.gforge.inria.fr/
 *
 * This software is governed by the CeCILL-C License under French law and
 * abiding by the rules of distribution of free software. You can use, modify
 * and/or redistribute the software under the terms of the CeCILL-C license as
 * circulated by CEA, CNRS and INRIA at http://www.cecill.info.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C License for more details.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 */
package spoon.reflect.visitor.chain;

/**
 * Defines how a {@link CtScannerListener} drives the scanning of {@link spoon.reflect.visitor.EarlyTerminatingScanner}
 */
public enum ScanningMode {
	/**
	 * Continue with scanning in a normal way, the current element and all children are visited.
	 */
	NORMAL(true, true),
	/**
	 * Skip the current element and skip all its children.
	 */
	SKIP_ALL(false, false),
	/**
	 * Visit current element but skips all its children.
	 */
	SKIP_CHILDREN(true, false);

	public final boolean visitElement;
	public final boolean visitChildren;

	ScanningMode(boolean visitElement, boolean visitChildren) {
		this.visitElement = visitElement;
		this.visitChildren = visitChildren;
	}
}