me.legrange.tree.Tree Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simple-trees Show documentation

The newest version!

package me.legrange.tree;

import java.util.Optional;
import java.util.stream.Stream;

/** A tree for organising data.
 *
 * @param  The type of data contained in the tree
 */
public interface Tree {

    /**
     * Check if the tree contains the given data somewhere.
     *
     * @param object The object
     * @return Is it in the tree?
     */
    boolean contains(T object);

    /**
     * Return a stream that does pre-order depth-first traversal of the tree.
     *
     * @return The stream
     */
    Stream preOrderDepthStream();

    /**
     * Return a stream that does post-order depth-first traversal of the tree.
     *
     * @return The stream
     */
    Stream postOrderDepthStream();

    /**
     * Return a stream that does breadth-first traversal of the tree.
     *
     * @return The stream
     */
    Stream breadthStream();

    /**
     * Return the data at the root of the tree
     *
     * @return The data
     */
    T getRoot();

    /**
     * Return the depth of the tree.
     *
     * @return The depth
     */
    int getDepth();

    /**
     * Return the width of the tree
     *
     * @return
     */
    int getWidth();

    /**
     * Get the parent data for child data
     *
     * @param child The child data
     * @return The parent data
     */
    Optional getParent(T child);

}