javaslang.collection

Class Tree.Node<T>

java.lang.Object

javaslang.collection.Tree.Node<T>

Type Parameters:

T - value type

All Implemented Interfaces:

Serializable, Iterable<T>, Foldable<T>, Traversable<T>, Tree<T>, Value<T>

Enclosing interface:

Tree<T>

public static final class Tree.Node<T>
extends Object
implements Tree<T>, Serializable

Represents a tree node.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javaslang.collection.Tree

Tree.Empty<T>, Tree.Node<T>, Tree.Order

Constructor Summary

Constructors

Constructor and Description
Node(T value, List<Tree.Node<T>> children) Constructs a rose tree branch.

Method Summary

Modifier and Type	Method and Description
String	draw() Creates a neat 2-dimensional drawing of a tree.
boolean	equals(Object o) Clarifies that values have a proper equals() method implemented.
List<Tree.Node<T>>	getChildren() Returns the children of this tree.
T	getValue() Gets the value of this tree.
int	hashCode() Clarifies that values have a proper hashCode() method implemented.
boolean	isEmpty() Checks if this Traversable is empty.
boolean	isLeaf() Checks if this Tree is a leaf.
int	size() Returns the number of nodes (including root and leafs).
String	toString() Clarifies that values have a proper toString() method implemented.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javaslang.collection.Tree

branchCount, collector, distinct, distinctBy, distinctBy, drop, dropRight, dropUntil, dropWhile, empty, fill, filter, flatMap, foldRight, groupBy, grouped, hasDefiniteSize, head, headOption, init, initOption, isBranch, isTraversableAgain, iterator, iterator, leafCount, length, map, narrow, nodeCount, of, of, of, of, ofAll, partition, peek, replace, replaceAll, retainAll, scan, scanLeft, scanRight, sliding, sliding, span, spliterator, stringPrefix, tabulate, tail, tailOption, take, takeRight, takeUntil, takeWhile, transform, traverse, traverse, unzip, unzip3, values, values, zip, zipAll, zipWithIndex

Methods inherited from interface javaslang.collection.Traversable

average, containsAll, count, existsUnique, find, findLast, foldLeft, get, hash, isSingleValued, last, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkString, mkString, mkString, narrow, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, sum

Methods inherited from interface javaslang.collection.Foldable

fold, reduce, reduceOption

Methods inherited from interface javaslang.Value

contains, corresponds, eq, exists, forAll, forEach, getOption, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, narrow, out, out, stderr, stdout, toArray, toCharSeq, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaOptional, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toList, toMap, toOption, toQueue, toRight, toRight, toSet, toStack, toStream, toTree, toTry, toTry, toVector

Constructor Detail

Node

public Node(T value,
            List<Tree.Node<T>> children)

Constructs a rose tree branch.

Parameters:

value - A value.

children - A non-empty list of children.

Throws:

NullPointerException - if children is null

IllegalArgumentException - if children is empty

Method Detail

getChildren

public List<Tree.Node<T>> getChildren()

Description copied from interface: Tree

Returns the children of this tree.

Specified by:

getChildren in interface Tree<T>

Returns:

the tree's children

getValue

public T getValue()

Description copied from interface: Tree

Gets the value of this tree.

Specified by:

getValue in interface Tree<T>

Returns:

The value of this tree.

isEmpty

public boolean isEmpty()

Description copied from interface: Traversable

Checks if this Traversable is empty.

Specified by:

isEmpty in interface Traversable<T>

Specified by:

isEmpty in interface Value<T>

Returns:

true, if this Traversable contains no elements, false otherwise.

isLeaf

public boolean isLeaf()

Description copied from interface: Tree

Checks if this Tree is a leaf. A tree is a leaf if it is a Node with no children. Because the empty tree is no Node, it is not a leaf by definition.

Specified by:

isLeaf in interface Tree<T>

Returns:

true if this tree is a leaf, false otherwise.

size

public int size()

Description copied from interface: Tree

Returns the number of nodes (including root and leafs).

Specified by:

size in interface Traversable<T>

Specified by:

size in interface Tree<T>

Returns:

The size of the tree.

equals

public boolean equals(Object o)

Description copied from interface: Value

Clarifies that values have a proper equals() method implemented.

See Object.equals(Object).

Specified by:

equals in interface Tree<T>

Specified by:

equals in interface Value<T>

Overrides:

equals in class Object

Parameters:

o - An object

Returns:

true, if this equals o, false otherwise

hashCode

public int hashCode()

Description copied from interface: Value

Clarifies that values have a proper hashCode() method implemented.

See Object.hashCode().

Specified by:

hashCode in interface Tree<T>

Specified by:

hashCode in interface Value<T>

Overrides:

hashCode in class Object

Returns:

The hashcode of this object

toString

public String toString()

Description copied from interface: Value

Clarifies that values have a proper toString() method implemented.

See Object.toString().

Specified by:

toString in interface Tree<T>

Specified by:

toString in interface Value<T>

Overrides:

toString in class Object

Returns:

A String representation of this object

draw

public String draw()

Description copied from interface: Tree

Creates a neat 2-dimensional drawing of a tree. Unicode characters are used to draw node junctions.

Specified by:

draw in interface Tree<T>

Returns:

A nice string representation of the tree.