org.solovyev.common.collections.tree.MutableTreeNode Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.0.7

Show newest version

package org.solovyev.common.collections.tree;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.solovyev.common.JPredicate;

import java.util.Collection;
import java.util.Iterator;

/**
 * User: serso
 * Date: 4/1/12
 * Time: 12:27 PM
 */

/**
 * Mutable interface of TreeNode
 */
public interface MutableTreeNode extends TreeNode {

    @Nullable
    MutableTreeNode findOwnChild(@NotNull JPredicate> finder);

    void setData(@Nullable T data);

    @NotNull
    Collection> getOwnChildren();

    @NotNull
    Iterator> getOwnChildrenIterator();

    @NotNull
    Collection> getAllChildren();

    /**
     * @param node node to be added. The parent specified in the node will be overwritten by this tree node
     */
    void addChild(@NotNull MutableTreeNode node);

    /**
     * @param data data to be added in the node
     * @return just added tree node
     */
    @NotNull
    MutableTreeNode addChild(@NotNull T data);

    @NotNull
    MutableTreeNode  addChildIfNotExists(@NotNull T data);

    /**
     * Method removes from OWN children elements which are applied by predicate
     * @param predicate removal condition
     */
    void removeOwnChildIf(@NotNull JPredicate> predicate);

    /**
     * Method removes from ALL children elements which are applied by predicate
     * @param predicate removal condition
     */
    void removeChildIf(@NotNull JPredicate> predicate);


    /**
     * @param parent parent of current node
     */
    void setParent(@Nullable TreeNode parent);
}