/*
 * The MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package spoon.visualisation.spoon;

import java.util.List;
import org.jetbrains.annotations.NotNull;
import spoon.reflect.declaration.CtElement;

/**
 * Base class for visiting Spoon AST for our visualisation purpose.
 */
public abstract class SpoonElementVisitor {
	final int levelsToIgnore;

	SpoonElementVisitor(final int levelsToIgnore) {
		super();
		this.levelsToIgnore = levelsToIgnore;
	}

	/**
	 * Visits the given Spoon element
	 * @param elt The spoon element to visit.
	 * @param level The depth level.
	 * @param label The title text that corresponds to the given element
	 * @param linesPosition The line positions of the given element
	 */
	public abstract void visitElement(final CtElement elt, final int level, final @NotNull TreeNodeLabel label,
		final List<Integer> linesPosition);
}
