org.conqat.lib.commons.visitor.ITreeWalker Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of teamscale-lib-commons Show documentation

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.conqat.lib.commons.visitor;

import java.util.Collection;

import org.conqat.lib.commons.error.NeverThrownRuntimeException;

/**
 * Interface for a tree walker, i.e. a class which allows the traversal of a tree. The implementor
 * has to make sure, that this really is a tree, i.e. for two different node, the children returned
 * must be disjunctive, and traversing the tree may not result in loops.
 * 
 * @param 
 *            the type used for the nodes of the tree.
 * @param 
 *            the type of exception thrown. Use {@link NeverThrownRuntimeException} if no exception
 *            is thrown
 * 
 * @author hummelb
 */
public interface ITreeWalker {

	/**
	 * Returns the children of the given tree node. The returned collection may not contain duplicate
	 * entries.
	 */
	public Collection getChildren(T node) throws X;
}