E - public interface AddressTrieOps<E extends Address> extends TreeOps<E>
| Modifier and Type | Interface and Description |
|---|---|
static interface |
AddressTrieOps.AddressTrieAddOps<E extends Address>
Provides an interface to the trie add operations.
|
static interface |
AddressTrieOps.AssociativeAddressTrieOps<K extends Address,V>
Provides an interface to the associative trie operations.
|
static interface |
AddressTrieOps.AssociativeAddressTriePutOps<K extends Address,V>
Provides an interface to the associative trie put operations.
|
| Modifier and Type | Method and Description |
|---|---|
Iterator<? extends AddressTrie.TrieNode<E>> |
allNodeIterator(boolean forward)
Iterates through the nodes (not just the added nodes) in forward or reverse tree order.
|
Spliterator<? extends AddressTrie.TrieNode<E>> |
allNodeSpliterator(boolean forward)
Creates a
Spliterator over the nodes in forward or reverse natural tree order. |
E |
ceiling(E addr)
Returns the lowest added address greater than or equal to the given address.
|
AddressTrie.TrieNode<E> |
ceilingAddedNode(E addr)
Returns the added node whose address is the lowest address greater than or equal to the given address.
|
Iterator<? extends AddressTrie.TrieNode<E>> |
containedFirstAllNodeIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a post-order binary tree traversal.
|
Iterator<? extends AddressTrie.TrieNode<E>> |
containedFirstIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a post-order binary tree traversal of the added nodes.
|
<C> BinaryTreeNode.CachingIterator<? extends AddressTrie.TrieNode<E>,E,C> |
containingFirstAllNodeIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a pre-order binary tree traversal.
|
<C> BinaryTreeNode.CachingIterator<? extends AddressTrie.TrieNode<E>,E,C> |
containingFirstIterator(boolean forwardSubNodeOrder)
Returns an iterator that does a pre-order binary tree traversal of the added nodes.
|
boolean |
contains(E addr)
Returns whether the given address or prefix block subnet is in the trie (as an added element).
|
boolean |
elementContains(E addr)
Checks if a prefix block subnet or address in the trie contains the given subnet or address.
|
AddressTrie.TrieNode<E> |
elementsContainedBy(E addr)
Checks if a part of this trie is contained by the given prefix block subnet or individual address.
|
AddressTrie.TrieNode<E> |
elementsContaining(E addr)
Finds the added subnets and/or addresses in the trie that contain the given individual address or prefix block subnet.
|
AddressTrie.TrieNode<E> |
firstAddedNode()
Returns the added node with the first (lowest valued) key,
or null if there are no added entries in this trie or subtrie
|
AddressTrie.TrieNode<E> |
firstNode()
Returns the node with the first (lowest valued) key, whether the node is added or not
|
E |
floor(E addr)
Returns the highest added address less than or equal to the given address.
|
AddressTrie.TrieNode<E> |
floorAddedNode(E addr)
Returns the added node whose address is the highest address less than or equal to the given address.
|
default AddressTrie.TrieNode<E> |
getAddedNode(E addr)
Gets trie nodes representing added elements.
|
AddressTrie.TrieNode<E> |
getNode(E addr)
Gets the node corresponding to the given address, returns null if not such element exists.
|
E |
higher(E addr)
Returns the lowest added address strictly greater than the given address.
|
AddressTrie.TrieNode<E> |
higherAddedNode(E addr)
Returns the added node whose address is the lowest address strictly greater than the given address.
|
AddressTrie.TrieNode<E> |
lastAddedNode()
Returns the added node with the last (highest valued) key,
or null if there are no added elements in this trie or subtrie
|
AddressTrie.TrieNode<E> |
lastNode()
Returns the node with the last (highest valued) key, whether the node is added or not
|
E |
longestPrefixMatch(E addr)
Of all the added subnets or address whose prefix matches the given address, returns the one with the longest prefix.
|
AddressTrie.TrieNode<E> |
longestPrefixMatchNode(E 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.
|
E |
lower(E addr)
Returns the highest added address strictly less than the given address.
|
AddressTrie.TrieNode<E> |
lowerAddedNode(E addr)
Returns the added node whose address is the highest address strictly less than the given address.
|
Iterator<? extends AddressTrie.TrieNode<E>> |
nodeIterator(boolean forward)
Iterates through the added nodes in forward or reverse natural tree order.
|
Spliterator<? extends AddressTrie.TrieNode<E>> |
nodeSpliterator(boolean forward)
Creates a
Spliterator over the added nodes in forward or reverse natural tree order. |
boolean |
remove(E addr)
Removes the given single address or prefix block subnet from the trie.
|
AddressTrie.TrieNode<E> |
removeElementsContainedBy(E addr)
Removes any single address or prefix block subnet from the trie that is contained in the given individual address or prefix block subnet.
|
E |
shortestPrefixMatch(E addr)
Of all the added subnets or address whose prefix matches the given address, returns the one with the shortest prefix.
|
AddressTrie.TrieNode<E> |
shortestPrefixMatchNode(E addr)
Finds the containing subnet or address in the trie with the largest subnet size,
which is equivalent to finding the subnet or address with the shortest matching prefix.
|
descendingIterator, descendingSpliterator, iterator, spliteratorAddressTrie.TrieNode<E> getNode(E addr)
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.
addr - contains(Address)default AddressTrie.TrieNode<E> getAddedNode(E addr)
Use contains(Address) to check for the existence of a given address in the trie,
as well as getNode(Address) to search for all nodes including those not-added but also auto-generated nodes for subnet blocks.
addr - boolean elementContains(E addr)
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 true if the subnet or address is contained by a trie element, false otherwise.
To get all the containing addresses, use elementsContaining(Address).
addr - boolean contains(E addr)
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 true if the prefix block or address address exists already in the trie, false otherwise.
Use getAddedNode(Address) to get the node for the address rather than just checking for its existence.
addr - boolean remove(E addr)
Removing an element will not remove contained elements (nodes for contained blocks and addresses).
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 true if the prefix block or address was removed, false if not already in the trie.
You can also remove by calling getAddedNode(Address) to get the node and then calling BinaryTreeNode.remove() on the node.
When an address is removed, the corresponding node may remain in the trie if it remains a subnet block for two sub-nodes. If the corresponding node can be removed from the trie, it will be.
addr - removeElementsContainedBy(Address)AddressTrie.TrieNode<E> removeElementsContainedBy(E addr)
Goes further than 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 removeElementsContainedBy(Address) will remove them both,
while 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.
addr - AddressTrie.TrieNode<E> elementsContainedBy(E addr)
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.
addr - AddressTrie.TrieNode<E> elementsContaining(E addr)
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 elementContains(Address) to check for the existence of a containing address.
addr - AddressTrie.TrieNode<E> longestPrefixMatchNode(E addr)
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 elementContains(Address) to check for the existence of a containing address.
To get all the containing addresses, use elementsContaining(Address).
Use longestPrefixMatch(Address) to get the address corresponding to the result of this method.
addr - E longestPrefixMatch(E addr)
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 elementContains(Address) to check for the existence of a containing address.
To get all the containing addresses (subnets with matching prefix), use elementsContaining(Address).
To get the node corresponding to the result of this method, use longestPrefixMatchNode(Address)
addr - AddressTrie.TrieNode<E> shortestPrefixMatchNode(E addr)
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 elementContains(Address) to check for the existence of a containing address.
To get all the containing addresses, use elementsContaining(Address).
Use shortestPrefixMatch(Address) to get the address corresponding to the result of this method.
addr - E shortestPrefixMatch(E addr)
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 elementContains(Address) to check for the existence of a containing address.
To get all the containing addresses (subnets with matching prefix), use elementsContaining(Address).
To get the node corresponding to the result of this method, use shortestPrefixMatchNode(Address)
addr - Iterator<? extends AddressTrie.TrieNode<E>> nodeIterator(boolean forward)
TreeOps
This iterator supports the Iterator.remove() operation.
See TreeOps for more details on the ordering.
nodeIterator in interface TreeOps<E extends Address>forward - if true, goes in ascending order, otherwise descendingIterator<? extends AddressTrie.TrieNode<E>> allNodeIterator(boolean forward)
TreeOps
See TreeOps for more details on the ordering.
This iterator supports the Iterator.remove() operation.
allNodeIterator in interface TreeOps<E extends Address>forward - if true, goes in ascending order, otherwise descending<C> BinaryTreeNode.CachingIterator<? extends AddressTrie.TrieNode<E>,E,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 TreeOps<E extends Address>forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.<C> BinaryTreeNode.CachingIterator<? extends AddressTrie.TrieNode<E>,E,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");
}
}
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 TreeOps<E extends Address>forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.Iterator<? extends AddressTrie.TrieNode<E>> containedFirstIterator(boolean forwardSubNodeOrder)
TreeOps
This iterator supports the Iterator.remove() operation.
See TreeOps for more details on the ordering.
containedFirstIterator in interface TreeOps<E extends Address>forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.Iterator<? extends AddressTrie.TrieNode<E>> 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 TreeOps<E extends Address>forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.Spliterator<? extends AddressTrie.TrieNode<E>> nodeSpliterator(boolean forward)
TreeOpsSpliterator over the added nodes in forward or reverse natural tree order.
See TreeOps for more details on the ordering.
nodeSpliterator in interface TreeOps<E extends Address>forward - if true, goes in ascending order, otherwise descendingSpliterator<? extends AddressTrie.TrieNode<E>> allNodeSpliterator(boolean forward)
TreeOpsSpliterator over the nodes in forward or reverse natural tree order.
See TreeOps for more details on the ordering.
allNodeSpliterator in interface TreeOps<E extends Address>forward - if true, goes in ascending order, otherwise descendingAddressTrie.TrieNode<E> firstNode()
AddressTrie.TrieNode<E> lastNode()
AddressTrie.TrieNode<E> firstAddedNode()
AddressTrie.TrieNode<E> lastAddedNode()
AddressTrie.TrieNode<E> floorAddedNode(E addr)
addr - AddressTrie.TrieNode<E> lowerAddedNode(E addr)
addr - AddressTrie.TrieNode<E> ceilingAddedNode(E addr)
addr - AddressTrie.TrieNode<E> higherAddedNode(E addr)
addr - E floor(E addr)
addr - E lower(E addr)
addr - E ceiling(E addr)
addr -