X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fnet%2Fpterodactylus%2Futil%2Fdata%2FNode.java;h=3615b36c077465e33cdea0c557835fec3436d572;hb=c63257e8cc0ba1a5aca9364b22171abe7279d479;hp=950ed990874b31058b57f3b9a426904fba065808;hpb=f52356f8351e099a243ee7b470a37f449bc88b1b;p=jSite2.git diff --git a/src/net/pterodactylus/util/data/Node.java b/src/net/pterodactylus/util/data/Node.java index 950ed99..3615b36 100644 --- a/src/net/pterodactylus/util/data/Node.java +++ b/src/net/pterodactylus/util/data/Node.java @@ -8,7 +8,7 @@ import java.util.Iterator; * A node that can be stored in a {@link Tree}. A node has exactly one parent * (which is null if the node is the {@link Tree#getRootNode()} * of the tree) and an arbitrary amount of child nodes. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @param * The type of the element to store @@ -17,21 +17,21 @@ public interface Node> extends Iterable>, Compar /** * Returns the parent node of the node. - * + * * @return The parent node */ public Node getParent(); /** * Returns the element that is stored in the node. - * + * * @return The node’s element */ public E getElement(); /** * Adds an element as a child to this node and returns the created node. - * + * * @param child * The child node’s element * @return The created child node @@ -40,14 +40,14 @@ public interface Node> extends Iterable>, Compar /** * Returns the number of children this node has. - * + * * @return The number of children */ public int size(); /** * Returns the child at the given index. - * + * * @param index * The index of the child * @return The child at the given index @@ -56,7 +56,7 @@ public interface Node> extends Iterable>, Compar /** * Returns the direct child node that contains the given element. - * + * * @param element * The element * @return The direct child node containing the given element, or @@ -67,7 +67,7 @@ public interface Node> extends Iterable>, Compar /** * Returns whether the given node is a direct child of this node. - * + * * @param childNode * The child node * @return true if the given node is a direct child of this @@ -78,7 +78,7 @@ public interface Node> extends Iterable>, Compar /** * Returns whether this node contains a child node containing the given * element. - * + * * @param element * The element * @return true if this node contains a direct child node @@ -88,7 +88,7 @@ public interface Node> extends Iterable>, Compar /** * Returns the index of the given child node. - * + * * @param childNode * The child node * @return The index of the child node, or -1 if the child @@ -98,7 +98,7 @@ public interface Node> extends Iterable>, Compar /** * Returns the index of the child node containing the given element. - * + * * @param element * The element * @return The index of the child node, or -1 if the child @@ -109,7 +109,7 @@ public interface Node> extends Iterable>, Compar /** * Remove the given child node from this node. If the given node is not a * child of this node, nothing happens. - * + * * @param childNode * The child node to remove */ @@ -118,7 +118,7 @@ public interface Node> extends Iterable>, Compar /** * Removes the child node that contains the given element. The element in * the node is checked using {@link Object#equals(Object)}. - * + * * @param child * The child element to remove */ @@ -126,7 +126,7 @@ public interface Node> extends Iterable>, Compar /** * Removes the child at the given index. - * + * * @param childIndex * The index of the child to remove */ @@ -145,7 +145,7 @@ public interface Node> extends Iterable>, Compar /** * Searches this node’s children recursively for a node that contains the * given element. - * + * * @param element * The element to search * @return The node that contains the given element, or null @@ -160,7 +160,7 @@ public interface Node> extends Iterable>, Compar /** * Sorts all children with the given comparator. - * + * * @param comparator * The comparator used to sort the children */