public static class IPv6AddressTrie.IPv6TrieNode extends AddressTrie.TrieNode<IPv6Address>
BinaryTreeNode.CachingIterator<N extends BinaryTreeNode<E>,E,C>
AddressTrieOps.AddressTrieAddOps<E extends Address>, AddressTrieOps.AssociativeAddressTrieOps<K extends Address,V>, AddressTrieOps.AssociativeAddressTriePutOps<K extends Address,V>
Constructor and Description |
---|
IPv6TrieNode() |
Modifier and Type | Method and Description |
---|---|
Iterator<IPv6AddressTrie.IPv6TrieNode> |
allNodeIterator(boolean forward)
Iterates through all the nodes of the sub-tree with this node as the root, in forward or reverse tree order.
|
Spliterator<IPv6AddressTrie.IPv6TrieNode> |
allNodeSpliterator(boolean forward)
Creates a
Spliterator over the nodes in forward or reverse natural tree order. |
IPv6AddressTrie |
asNewTrie()
Creates a new sub-trie, copying the nodes starting with this node as root.
|
Iterator<IPv6AddressTrie.IPv6TrieNode> |
blockSizeAllNodeIterator(boolean lowerSubNodeFirst)
Iterates all the nodes, ordered by keys from largest prefix blocks to smallest and then to individual addresses,
in the sub-trie with this node as the root.
|
<C> BinaryTreeNode.CachingIterator<IPv6AddressTrie.IPv6TrieNode,IPv6Address,C> |
blockSizeCachingAllNodeIterator()
Iterates all nodes, ordered by keys from largest prefix blocks to smallest and then to individual addresses,
in the sub-trie with this node as the root.
|
Iterator<IPv6AddressTrie.IPv6TrieNode> |
blockSizeNodeIterator(boolean lowerSubNodeFirst)
Iterates the added nodes, ordered by keys from largest prefix blocks to smallest and then to individual addresses,
in the sub-trie with this node as the root.
|
IPv6AddressTrie.IPv6TrieNode |
ceilingAddedNode(IPv6Address addr)
Returns the added node whose address is the lowest address greater than or equal to the given address.
|
IPv6AddressTrie.IPv6TrieNode |
clone()
Clones the node.
|
IPv6AddressTrie.IPv6TrieNode |
cloneTree()
Clones the sub-tree starting with this node as root.
|
Iterator<IPv6AddressTrie.IPv6TrieNode> |
containedFirstAllNodeIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a post-order binary tree traversal.
|
Iterator<IPv6AddressTrie.IPv6TrieNode> |
containedFirstIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a post-order binary tree traversal of the added nodes.
|
<C> BinaryTreeNode.CachingIterator<IPv6AddressTrie.IPv6TrieNode,IPv6Address,C> |
containingFirstAllNodeIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a pre-order binary tree traversal.
|
<C> BinaryTreeNode.CachingIterator<IPv6AddressTrie.IPv6TrieNode,IPv6Address,C> |
containingFirstIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a pre-order binary tree traversal of the added nodes.
|
IPv6AddressTrie.IPv6TrieNode |
elementsContainedBy(IPv6Address addr)
Checks if a part of this trie is contained by the given prefix block subnet or individual address.
|
IPv6AddressTrie.IPv6TrieNode |
elementsContaining(IPv6Address addr)
Finds the added subnets and/or addresses in the trie that contain the given individual address or prefix block subnet.
|
boolean |
equals(Object o)
Returns whether the key values match those of the given node
|
IPv6AddressTrie.IPv6TrieNode |
firstAddedNode()
Returns the first (lowest valued) added node in the sub-tree originating from this node,
or null if there are no added entries in this tree or sub-tree
|
IPv6AddressTrie.IPv6TrieNode |
firstNode()
Returns the first (lowest valued) node in the sub-tree originating from this node.
|
IPv6AddressTrie.IPv6TrieNode |
floorAddedNode(IPv6Address addr)
Returns the added node whose address is the highest address less than or equal to the given address.
|
IPv6AddressTrie.IPv6TrieNode |
getAddedNode(IPv6Address addr)
Gets trie nodes representing added elements.
|
IPv6AddressTrie.IPv6TrieNode |
getLowerSubNode()
Returns the sub node whose address is smallest in value
|
IPv6AddressTrie.IPv6TrieNode |
getNode(IPv6Address addr)
Gets the node corresponding to the given address, returns null if not such element exists.
|
IPv6AddressTrie.IPv6TrieNode |
getParent()
Returns the node for the subnet block containing this node.
|
IPv6AddressTrie.IPv6TrieNode |
getUpperSubNode()
Returns the sub-node whose address is largest in value
|
IPv6AddressTrie.IPv6TrieNode |
higherAddedNode(IPv6Address addr)
Returns the added node whose address is the lowest address strictly greater than the given address.
|
IPv6AddressTrie.IPv6TrieNode |
lastAddedNode()
Returns the last (highest valued) added node in the sub-tree originating from this node,
or null if there are no added entries in this tree or sub-tree
|
IPv6AddressTrie.IPv6TrieNode |
lastNode()
Returns the last (highest valued) node in the sub-tree originating from this node.
|
IPv6AddressTrie.IPv6TrieNode |
longestPrefixMatchNode(IPv6Address addr)
Finds the containing subnet or address in the trie with the smallest subnet size,
which is equivalent to finding the subnet or address with the longest matching prefix.
|
IPv6AddressTrie.IPv6TrieNode |
lowerAddedNode(IPv6Address addr)
Returns the added node whose address is the highest address strictly less than the given address.
|
IPv6AddressTrie.IPv6TrieNode |
nextAddedNode()
Returns the next node in the tree that is an added node, following the tree order,
or null if there is no such node.
|
IPv6AddressTrie.IPv6TrieNode |
nextNode()
Returns the node that follows this node following the tree order
|
Iterator<IPv6AddressTrie.IPv6TrieNode> |
nodeIterator(boolean forward)
Iterates through the added nodes of the sub-tree with this node as the root, in forward or reverse tree order.
|
Spliterator<IPv6AddressTrie.IPv6TrieNode> |
nodeSpliterator(boolean forward)
Creates a
Spliterator over the added nodes in forward or reverse natural tree order. |
IPv6AddressTrie.IPv6TrieNode |
previousAddedNode()
Returns the previous node in the tree that is an added node, following the tree order in reverse,
or null if there is no such node.
|
IPv6AddressTrie.IPv6TrieNode |
previousNode()
Returns the node that precedes this node following the tree order.
|
IPv6AddressTrie.IPv6TrieNode |
removeElementsContainedBy(IPv6Address addr)
Removes any single address or prefix block subnet from the trie that is contained in the given individual address or prefix block subnet.
|
ceiling, contains, descendingSpliterator, elementContains, floor, higher, longestPrefixMatch, lower, remove, shortestPrefixMatch, shortestPrefixMatchNode, spliterator
clear, descendingIterator, getKey, hashCode, isAdded, isEmpty, isLeaf, isRoot, iterator, nodeSize, remove, setAdded, size, toString, toTreeString, treeEquals, treeHashCode
descendingIterator, iterator
public IPv6AddressTrie.IPv6TrieNode getUpperSubNode()
AddressTrie.TrieNode
getUpperSubNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode getLowerSubNode()
AddressTrie.TrieNode
getLowerSubNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode getParent()
AddressTrie.TrieNode
getParent
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode removeElementsContainedBy(IPv6Address addr)
AddressTrieOps
Goes further than AddressTrieOps.remove(Address)
, not requiring a match to an inserted node, and also removing all the sub-nodes of any removed node or sub-node.
For example, after inserting 1.2.3.0 and 1.2.3.1, passing 1.2.3.0/31 to AddressTrieOps.removeElementsContainedBy(Address)
will remove them both,
while AddressTrieOps.remove(Address)
will remove nothing.
After inserting 1.2.3.0/31, then #remove(Address) will remove 1.2.3.0/31, but will leave 1.2.3.0 and 1.2.3.1 in the trie.
It cannot partially delete a node, such as deleting a single address from a prefix block represented by a node. It can only delete the whole node if the whole address or block represented by that node is contained in the given address or block.
If the given address is not a single address nor prefix block, then this method throws IllegalArgumentException.
If not a single address nor prefix block, the Partition
class can be used to convert the address before calling this method.
See AddressTrieOps.AddressTrieAddOps.add(Address)
for more details.
Returns the root node of the subtrie that was removed from the trie, or null if nothing was removed.
removeElementsContainedBy
in interface AddressTrieOps<IPv6Address>
removeElementsContainedBy
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode elementsContainedBy(IPv6Address addr)
AddressTrieOps
If the given address is not a single address nor prefix block, then this method throws IllegalArgumentException.
If not a single address nor prefix block, the Partition
class can be used to convert the address before calling this method.
See AddressTrieOps.AddressTrieAddOps.add(Address)
for more details.
Returns the root node of the contained subtrie, or null if no subtrie is contained.
The node returned need not be an "added" node, see BinaryTreeNode.isAdded()
for more details on added nodes.
The returned subtrie is backed by this trie, so changes in this trie are reflected in those nodes and vice-versa.
elementsContainedBy
in interface AddressTrieOps<IPv6Address>
elementsContainedBy
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode elementsContaining(IPv6Address addr)
AddressTrieOps
If the given address is not a single address nor prefix block, then this method throws IllegalArgumentException.
If not a single address nor prefix block, the Partition
class can be used to convert the address before calling this method.
See AddressTrieOps.AddressTrieAddOps.add(Address)
for more details.
Returns a list of the nodes for prefix block subnets and addresses from the trie that contain the address or block.
The list consists only of added nodes, see BinaryTreeNode.isAdded()
for more details on added nodes.
The list is constructed as a trie in which each parent node has only one sub-node.
Use AddressTrieOps.elementContains(Address)
to check for the existence of a containing address.
elementsContaining
in interface AddressTrieOps<IPv6Address>
elementsContaining
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode longestPrefixMatchNode(IPv6Address addr)
AddressTrieOps
If the given address is not a single address nor prefix block, then this method throws IllegalArgumentException.
If not a single address nor prefix block, the Partition
class can be used to convert the address before calling this method.
See AddressTrieOps.AddressTrieAddOps.add(Address)
for more details.
Returns null if no added subnet or address contains the given argument.
Use AddressTrieOps.elementContains(Address)
to check for the existence of a containing address.
To get all the containing addresses, use AddressTrieOps.elementsContaining(Address)
.
Use AddressTrieOps.longestPrefixMatch(Address)
to get the address corresponding to the result of this method.
longestPrefixMatchNode
in interface AddressTrieOps<IPv6Address>
longestPrefixMatchNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode getAddedNode(IPv6Address addr)
AddressTrieOps
Use AddressTrieOps.contains(Address)
to check for the existence of a given address in the trie,
as well as AddressTrieOps.getNode(Address)
to search for all nodes including those not-added but also auto-generated nodes for subnet blocks.
public IPv6AddressTrie.IPv6TrieNode getNode(IPv6Address addr)
AddressTrieOps
If added is true, returns only nodes representing added elements, otherwise returns any node, including a prefix block that was not added.
If the given address is not a single address nor prefix block, then this method throws IllegalArgumentException.
If not a single address nor prefix block, the Partition
class can be used to convert the address before calling this method.
See AddressTrieOps.AddressTrieAddOps.add(Address)
for more details.
getNode
in interface AddressTrieOps<IPv6Address>
getNode
in class AddressTrie.TrieNode<IPv6Address>
AddressTrieOps.contains(Address)
public Iterator<IPv6AddressTrie.IPv6TrieNode> nodeIterator(boolean forward)
BinaryTreeNode
nodeIterator
in interface AddressTrieOps<IPv6Address>
nodeIterator
in interface TreeOps<IPv6Address>
nodeIterator
in class AddressTrie.TrieNode<IPv6Address>
forward
- if true, goes in ascending order, otherwise descendingpublic Iterator<IPv6AddressTrie.IPv6TrieNode> allNodeIterator(boolean forward)
BinaryTreeNode
allNodeIterator
in interface AddressTrieOps<IPv6Address>
allNodeIterator
in interface TreeOps<IPv6Address>
allNodeIterator
in class AddressTrie.TrieNode<IPv6Address>
forward
- if true, goes in ascending order, otherwise descendingpublic Iterator<IPv6AddressTrie.IPv6TrieNode> blockSizeNodeIterator(boolean lowerSubNodeFirst)
AddressTrie.TrieNode
This iterator supports the Iterator.remove()
operation.
blockSizeNodeIterator
in class AddressTrie.TrieNode<IPv6Address>
lowerSubNodeFirst
- if true, for blocks of equal size the lower is first, otherwise the reverse orderpublic Iterator<IPv6AddressTrie.IPv6TrieNode> blockSizeAllNodeIterator(boolean lowerSubNodeFirst)
AddressTrie.TrieNode
This iterator supports the Iterator.remove()
operation.
blockSizeAllNodeIterator
in class AddressTrie.TrieNode<IPv6Address>
lowerSubNodeFirst
- if true, for blocks of equal size the lower is first, otherwise the reverse orderpublic <C> BinaryTreeNode.CachingIterator<IPv6AddressTrie.IPv6TrieNode,IPv6Address,C> blockSizeCachingAllNodeIterator()
AddressTrie.TrieNode
blockSizeCachingAllNodeIterator
in class AddressTrie.TrieNode<IPv6Address>
public <C> BinaryTreeNode.CachingIterator<IPv6AddressTrie.IPv6TrieNode,IPv6Address,C> containingFirstIterator(boolean forwardSubNodeOrder)
TreeOps
This iterator supports the Iterator.remove()
operation.
Once a given node is visited, the iterator allows you to cache an object corresponding to the lower or upper sub-node that can be retrieved when you later visit that sub-node.
Objects are cached only with nodes to be visited. So for this iterator that means an object will be cached with the first added lower or upper sub-node, the next lower or upper sub-node to be visited, which is not necessarily the direct lower or upper sub-node of a given node.
The caching allows you to provide iteration context from a parent to its sub-nodes when iterating. The caching and retrieval is done in constant-time and linear space (proportional to tree size).
See TreeOps
for more details on the ordering.
containingFirstIterator
in interface AddressTrieOps<IPv6Address>
containingFirstIterator
in interface TreeOps<IPv6Address>
containingFirstIterator
in class AddressTrie.TrieNode<IPv6Address>
forwardSubNodeOrder
- if true, a left sub-node will be visited before the right sub-node of the same parent node.public <C> BinaryTreeNode.CachingIterator<IPv6AddressTrie.IPv6TrieNode,IPv6Address,C> containingFirstAllNodeIterator(boolean forwardSubNodeOrder)
TreeOps
This iterator supports the Iterator.remove()
operation.
Once a given node is visited, the iterator allows you to cache an object corresponding to the lower or upper sub-node that can be retrieved when you later visit that sub-node. That allows you to provide iteration context from a parent to its sub-nodes when iterating. The caching and retrieval is done in constant-time and linear space (proportional to tree size).
Here is an example showing usage of the caching. Consider this recursive code doing a pre-order traversal:
IPv6AddressTrie ipv6Tree = ...;
visitRecursive(ipv6Tree.getRoot(), null);
static <E> void visitRecursive(BinaryTreeNode<E> node, String direction) {
if(direction == null) {
direction = "root";
}
System.out.println("visited " + direction + " " + node);
BinaryTreeNode<E> sub = node.getLowerSubNode();
if(sub != null) {
visitRecursive(sub, direction + " left");
}
sub = node.getUpperSubNode();
if(sub != null) {
visitRecursive(sub, direction + " right");
}
}
The following iterative code provides the same functionality:
visitIterative(ipv6Tree.getRoot());
static <E> void visitIterative(BinaryTreeNode<E> node) {
CachingIterator<? extends BinaryTreeNode<E>, E, String>iterator = node.containingFirstAllNodeIterator(true);
while(iterator.hasNext()) {
BinaryTreeNode<E> next = iterator.next();
String direction = iterator.getCached();
if(direction == null) {
direction = "root";
}
System.out.println("visited " + direction + " " + next);
iterator.cacheWithLowerSubNode(direction + " left");
iterator.cacheWithUpperSubNode(direction + " right");
}
}
See TreeOps
for more details on the ordering.
containingFirstAllNodeIterator
in interface AddressTrieOps<IPv6Address>
containingFirstAllNodeIterator
in interface TreeOps<IPv6Address>
containingFirstAllNodeIterator
in class AddressTrie.TrieNode<IPv6Address>
forwardSubNodeOrder
- if true, a left sub-node will be visited before the right sub-node of the same parent node.public Iterator<IPv6AddressTrie.IPv6TrieNode> containedFirstIterator(boolean forwardSubNodeOrder)
TreeOps
This iterator supports the Iterator.remove()
operation.
See TreeOps
for more details on the ordering.
containedFirstIterator
in interface AddressTrieOps<IPv6Address>
containedFirstIterator
in interface TreeOps<IPv6Address>
containedFirstIterator
in class AddressTrie.TrieNode<IPv6Address>
forwardSubNodeOrder
- if true, a left sub-node will be visited before the right sub-node of the same parent node.public Iterator<IPv6AddressTrie.IPv6TrieNode> containedFirstAllNodeIterator(boolean forwardSubNodeOrder)
TreeOps
This iterator does not support the Iterator.remove()
operation.
If Iterator.remove()
is called it will throw UnsupportedOperationException
.
See TreeOps
for more details on the ordering.
containedFirstAllNodeIterator
in interface AddressTrieOps<IPv6Address>
containedFirstAllNodeIterator
in interface TreeOps<IPv6Address>
containedFirstAllNodeIterator
in class AddressTrie.TrieNode<IPv6Address>
forwardSubNodeOrder
- if true, a left sub-node will be visited before the right sub-node of the same parent node.public Spliterator<IPv6AddressTrie.IPv6TrieNode> nodeSpliterator(boolean forward)
TreeOps
Spliterator
over the added nodes in forward or reverse natural tree order.
See TreeOps
for more details on the ordering.
nodeSpliterator
in interface AddressTrieOps<IPv6Address>
nodeSpliterator
in interface TreeOps<IPv6Address>
nodeSpliterator
in class AddressTrie.TrieNode<IPv6Address>
forward
- if true, goes in ascending order, otherwise descendingpublic Spliterator<IPv6AddressTrie.IPv6TrieNode> allNodeSpliterator(boolean forward)
TreeOps
Spliterator
over the nodes in forward or reverse natural tree order.
See TreeOps
for more details on the ordering.
allNodeSpliterator
in interface AddressTrieOps<IPv6Address>
allNodeSpliterator
in interface TreeOps<IPv6Address>
allNodeSpliterator
in class AddressTrie.TrieNode<IPv6Address>
forward
- if true, goes in ascending order, otherwise descendingpublic IPv6AddressTrie.IPv6TrieNode previousAddedNode()
BinaryTreeNode
previousAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode nextAddedNode()
BinaryTreeNode
nextAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode nextNode()
BinaryTreeNode
nextNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode previousNode()
BinaryTreeNode
previousNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode lowerAddedNode(IPv6Address addr)
AddressTrieOps
lowerAddedNode
in interface AddressTrieOps<IPv6Address>
lowerAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode floorAddedNode(IPv6Address addr)
AddressTrieOps
floorAddedNode
in interface AddressTrieOps<IPv6Address>
floorAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode higherAddedNode(IPv6Address addr)
AddressTrieOps
higherAddedNode
in interface AddressTrieOps<IPv6Address>
higherAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode ceilingAddedNode(IPv6Address addr)
AddressTrieOps
ceilingAddedNode
in interface AddressTrieOps<IPv6Address>
ceilingAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode firstNode()
BinaryTreeNode
firstNode
in interface AddressTrieOps<IPv6Address>
firstNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode lastNode()
BinaryTreeNode
lastNode
in interface AddressTrieOps<IPv6Address>
lastNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode firstAddedNode()
BinaryTreeNode
firstAddedNode
in interface AddressTrieOps<IPv6Address>
firstAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode lastAddedNode()
BinaryTreeNode
lastAddedNode
in interface AddressTrieOps<IPv6Address>
lastAddedNode
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie asNewTrie()
AddressTrie.TrieNode
asNewTrie
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode cloneTree()
BinaryTreeNode
cloneTree
in class AddressTrie.TrieNode<IPv6Address>
public IPv6AddressTrie.IPv6TrieNode clone()
BinaryTreeNode
clone
in class AddressTrie.TrieNode<IPv6Address>
public boolean equals(Object o)
BinaryTreeNode
equals
in class AddressTrie.TrieNode<IPv6Address>