io.github.astrapi69.gen.tree.visitor.MaxIndexFinderTreeNodeVisitor Maven / Gradle / Ivy

Go to download

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

Project that holds a generic model for tree objects

There is a newer version: 10.1

/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * 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 io.github.astrapi69.gen.tree.visitor;

import java.util.Collection;

import io.github.astrapi69.design.pattern.visitor.Visitor;
import io.github.astrapi69.gen.tree.api.IBaseTreeNode;
import io.github.astrapi69.gen.tree.api.ITreeNode;
import lombok.Getter;

/**
 * This visitor visits all {@link ITreeNode} objects and adds them to a {@link Collection} object
 * with all descendant
 *
 * @param 
 *            the generic type of the value
 */
@Getter
public abstract class MaxIndexFinderTreeNodeVisitor>
	implements
		Visitor
{
	/**
	 * Placeholder for the maximum index of a tree
	 */
	K maxIndex;

	/**
	 * Instantiates a new {@link MergeTreeNodesVisitor} object
	 */
	public MaxIndexFinderTreeNodeVisitor()
	{
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void visit(T treeNode)
	{
		K id = treeNode.getId();
		if (maxIndex == null)
		{
			maxIndex = id;
		}
		if (isGreater(id))
		{
			maxIndex = id;
		}
	}

	/**
	 * Checks if the given id is greater than the current maxIndex
	 *
	 * @param id
	 *            the id to check
	 * @return true if the given id is greater than the current maxIndex otherwise
	 *         false
	 */
	public abstract boolean isGreater(K id);
}