com.scalified.tree.TraversalAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tree Show documentation

Tree Data Structure Java Library

There is a newer version: 0.2.5

/*
 * Copyright 2016 Scalified 
 *
 * 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 com.scalified.tree;

/**
 * An interface, which defines the action to perform while traversing
 * the tree
 *
 * @author shell
 * @version 1.0.0
 * @since 1.0.0
 */
public interface TraversalAction {

	/**
	 * Is called on each node, while traversing the tree
	 *
	 * @param node reference to the current node during tree traversal
	 */
	void perform(T node);

	/**
	 * Checks whether the traversal is completed and no more required
	 *
	 * @return {@code true} if traversal is completed and no more required,
	 *         {@code false} otherwise
	 */
	boolean isCompleted();

}