IPv4AddressAssociativeTrie (IPAddress javadoc by seancfoley)

java.lang.Object
- inet.ipaddr.format.util.AddressTrie<K>
- - inet.ipaddr.format.util.AssociativeAddressTrie<IPv4Address,V>
  - - inet.ipaddr.ipv4.IPv4AddressAssociativeTrie<V>

Type Parameters:

V - the type of the associated values

All Implemented Interfaces:

AddressTrieOps<IPv4Address>, AddressTrieOps.AddressTrieAddOps<IPv4Address>, AddressTrieOps.AssociativeAddressTrieOps<IPv4Address,V>, AddressTrieOps.AssociativeAddressTriePutOps<IPv4Address,V>, TreeOps<IPv4Address>, Serializable, Cloneable, Iterable<IPv4Address>
```
public class IPv4AddressAssociativeTrie<V>
extends AssociativeAddressTrie<IPv4Address,V>
```
An IPv4 address trie in which each node can be associated with a value. See AssociativeAddressTrie for more details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>
- Nested classes/interfaces inherited from class inet.ipaddr.format.util.AssociativeAddressTrie
  AssociativeAddressTrie.AssociativeTrieNode<K extends Address,V>
- Nested classes/interfaces inherited from class inet.ipaddr.format.util.AddressTrie
  AddressTrie.AddressComparator<E extends Address>, AddressTrie.TrieComparator<E extends Address>, AddressTrie.TrieNode<E extends Address>
- Nested classes/interfaces inherited from interface inet.ipaddr.format.util.AddressTrieOps
  AddressTrieOps.AddressTrieAddOps<E extends Address>, AddressTrieOps.AssociativeAddressTrieOps<K extends Address,V>, AddressTrieOps.AssociativeAddressTriePutOps<K extends Address,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`

Constructor Summary

Constructors
Constructor and Description

IPv4AddressAssociativeTrie()

Constructors
Constructor and Description
`IPv4AddressAssociativeTrie()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`addNode(IPv4Address addr)` Adds the given single address or prefix block subnet to the trie, if not already there.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`addTrie(AddressTrie.TrieNode<IPv4Address> trie)` Adds nodes matching the given sub-root node and all of its sub-nodes to the trie, if not already there.
`Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`allNodeIterator(boolean forward)` Iterates through the nodes (not just the added nodes) in forward or reverse tree order.
`Spliterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`allNodeSpliterator(boolean forward)` Creates a `Spliterator` over the nodes in forward or reverse natural tree order.
`Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`blockSizeAllNodeIterator(boolean lowerSubNodeFirst)` Iterates all nodes in the trie, ordered by keys from largest prefix blocks to smallest, and then to individual addresses.
`<C> BinaryTreeNode.CachingIterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>,IPv4Address,C>`	`blockSizeCachingAllNodeIterator()` Iterates all nodes, ordered by keys from largest prefix blocks to smallest, and then to individual addresses.
`Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`blockSizeNodeIterator(boolean lowerSubNodeFirst)` Iterates the added nodes in the trie, ordered by keys from largest prefix blocks to smallest, and then to individual addresses.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`ceilingAddedNode(IPv4Address addr)` Returns the added node whose address is the lowest address greater than or equal to the given address.
`IPv4AddressAssociativeTrie<V>`	`clone()` Copies the trie, but not the keys or values.
`AssociativeAddedTree<IPv4Address,V>`	`constructAddedNodesTree()` Provides an associative trie in which the root and each added node are mapped to a list of their respective direct added nodes.
`Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`containedFirstAllNodeIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a post-order binary tree traversal.
`Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`containedFirstIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a post-order binary tree traversal of the added nodes.
`<C> BinaryTreeNode.CachingIterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>,IPv4Address,C>`	`containingFirstAllNodeIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a pre-order binary tree traversal.
`Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`containingFirstIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a pre-order binary tree traversal of the added nodes.
`Iterator<E>`	`descendingIterator()` Traverses the added node keys in reverse natural tree order.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`elementsContainedBy(IPv4Address addr)` Checks if a part of this trie is contained by the given prefix block subnet or individual address.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`elementsContaining(IPv4Address 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 given argument is a trie with a set of nodes that equal the set of nodes in this trie
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`firstAddedNode()` Returns the added node with the first (lowest valued) key, or null if there are no added entries in this trie or subtrie
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`firstNode()` Returns the node with the first (lowest valued) key, whether the node is added or not
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`floorAddedNode(IPv4Address addr)` Returns the added node whose address is the highest address less than or equal to the given address.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`getAddedNode(IPv4Address addr)` Gets trie nodes representing added elements.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`getNode(IPv4Address addr)` Gets the node corresponding to the given address, returns null if not such element exists.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`getRoot()` Returns the root of this trie
`int`	`hashCode()`
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`higherAddedNode(IPv4Address addr)` Returns the added node whose address is the lowest address strictly greater than the given address.
`Iterator<E>`	`iterator()` Traverses the added node keys in natural tree order.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`lastAddedNode()` Returns the added node with the last (highest valued) key, or null if there are no added elements in this trie or subtrie
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`lastNode()` Returns the node with the last (highest valued) key, whether the node is added or not
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`longestPrefixMatchNode(IPv4Address 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.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`lowerAddedNode(IPv4Address addr)` Returns the added node whose address is the highest address strictly less than the given address.
`Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`nodeIterator(boolean forward)` Iterates through the added nodes in forward or reverse natural tree order.
`Spliterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>>`	`nodeSpliterator(boolean forward)` Creates a `Spliterator` over the added nodes in forward or reverse natural tree order.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`putNode(IPv4Address addr, V value)` Associates the specified value with the specified key in this map.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`putTrie(AssociativeAddressTrie.AssociativeTrieNode<IPv4Address,V> trie)` Adds nodes matching the given sub-root node and all of its sub-nodes to the trie, if not already there.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`remap(IPv4Address addr, Function<? super V,? extends V> remapper)` Remaps node values in the trie.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`remapIfAbsent(IPv4Address addr, Supplier<? extends V> remapper, boolean insertNull)` Remaps node values in the trie, but only for nodes that do not exist or are mapped to null.
`IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>`	`removeElementsContainedBy(IPv4Address addr)` Removes any single address or prefix block subnet from the trie that is contained in the given individual address or prefix block subnet.
`String`	`toAddedNodesTreeString()` Provides a flattened version of the trie showing only the contained added nodes and their containment structure, which is non-binary.

Methods inherited from class inet.ipaddr.format.util.AssociativeAddressTrie
asMap, get, put, putNew, shortestPrefixMatchNode

Methods inherited from class inet.ipaddr.format.util.AddressTrie
add, asSet, ceiling, clear, contains, decrement, descendingSpliterator, elementContains, floor, getComparator, higher, increment, isEmpty, longestPrefixMatch, lower, nodeSize, remove, shortestPrefixMatch, size, spliterator, toString, toString, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.format.util.AddressTrieOps
ceiling, contains, elementContains, floor, higher, longestPrefixMatch, lower, remove, shortestPrefixMatch

Methods inherited from interface inet.ipaddr.format.util.TreeOps
descendingIterator, descendingSpliterator, iterator, spliterator

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - IPv4AddressAssociativeTrie
```
public IPv4AddressAssociativeTrie()
```
- Method Detail
  - getRoot
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> getRoot()
```
    Returns the root of this trie
    
    Overrides:
    
    getRoot in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - removeElementsContainedBy
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> removeElementsContainedBy(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Removes any single address or prefix block subnet from the trie that is contained in the given individual address or prefix block subnet.
    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.
    
    Specified by:
    
    removeElementsContainedBy in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    removeElementsContainedBy in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - elementsContainedBy
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> elementsContainedBy(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Checks if a part of this trie is contained by the given prefix block subnet or individual address.
    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.
    
    Specified by:
    
    elementsContainedBy in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    elementsContainedBy in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - elementsContaining
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> elementsContaining(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Finds the added subnets and/or addresses in the trie that contain the given individual address or prefix block subnet.
    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.
    
    Specified by:
    
    elementsContaining in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    elementsContaining in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - longestPrefixMatchNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> longestPrefixMatchNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    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. Returns the node corresponding to that subnet.
    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.
    
    Specified by:
    
    longestPrefixMatchNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    longestPrefixMatchNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - getAddedNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> getAddedNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Gets trie nodes representing added elements.
    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.
    
    Specified by:
    
    getAddedNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    getAddedNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - getNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> getNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Gets the node corresponding to the given address, returns null if not such element exists.
    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.
    
    Specified by:
    
    getNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    getNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
    
    See Also:
    
    AddressTrieOps.contains(Address)
  - addNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> addNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps.AddressTrieAddOps
    
    Adds the given single address or prefix block subnet to the trie, if not already there.
    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 node for the added address, whether it was already in the trie or not.
    If you wish to know whether the node was already there when adding, use AddressTrieOps.AddressTrieAddOps.add(Address), or before adding you can use AddressTrieOps.getAddedNode(Address)
    
    Specified by:
    
    addNode in interface AddressTrieOps.AddressTrieAddOps<IPv4Address>
    
    Overrides:
    
    addNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - addTrie
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> addTrie(AddressTrie.TrieNode<IPv4Address> trie)
```
    Description copied from interface: AddressTrieOps.AddressTrieAddOps
    
    Adds nodes matching the given sub-root node and all of its sub-nodes to the trie, if not already there.
    For each added in the given node that does not exist in the trie, a copy of each node will be made that matches the trie type (associative or not), and the copy will be inserted into the trie.
    The node type need not match the node type of the trie, although the address type/version E must match. You can add associative nodes to tries with this method but associated values will all be null. If you want to preserve the values, use AssociativeAddressTriePutOps#putTrie(AssociativeTrieNode) instead.
    When adding one trie to another, this method is more efficient than adding each node of the first trie individually. When using this method, searching for the location to add sub-nodes starts from the inserted parent node.
    Returns the node corresponding to the given sub-root node, whether it was already in the trie or not.
    
    Specified by:
    
    addTrie in interface AddressTrieOps.AddressTrieAddOps<IPv4Address>
    
    Overrides:
    
    addTrie in class AddressTrie<IPv4Address>
    
    Returns:
  - nodeIterator
```
public Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> nodeIterator(boolean forward)
```
    Description copied from interface: TreeOps
    
    Iterates through the added nodes in forward or reverse natural tree order.
    This iterator supports the Iterator.remove() operation.
    See TreeOps for more details on the ordering.
    
    Specified by:
    
    nodeIterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    nodeIterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    nodeIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - allNodeIterator
```
public Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> allNodeIterator(boolean forward)
```
    Description copied from interface: TreeOps
    
    Iterates through the nodes (not just the added nodes) in forward or reverse tree order.
    
    See TreeOps for more details on the ordering. This iterator supports the Iterator.remove() operation.
    
    Specified by:
    
    allNodeIterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    allNodeIterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    allNodeIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - blockSizeNodeIterator
```
public Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> blockSizeNodeIterator(boolean lowerSubNodeFirst)
```
    Description copied from class: AddressTrie
    
    Iterates the added nodes in the trie, ordered by keys from largest prefix blocks to smallest, and then to individual addresses.
    This iterator supports the Iterator.remove() operation.
    
    Overrides:
    
    blockSizeNodeIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    lowerSubNodeFirst - if true, for blocks of equal size the lower is first, otherwise the reverse order
    
    Returns:
  - blockSizeAllNodeIterator
```
public Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> blockSizeAllNodeIterator(boolean lowerSubNodeFirst)
```
    Description copied from class: AddressTrie
    
    Iterates all nodes in the trie, ordered by keys from largest prefix blocks to smallest, and then to individual addresses.
    This iterator supports the Iterator.remove() operation.
    
    Overrides:
    
    blockSizeAllNodeIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    lowerSubNodeFirst - if true, for blocks of equal size the lower is first, otherwise the reverse order
    
    Returns:
  - blockSizeCachingAllNodeIterator
```
public <C> BinaryTreeNode.CachingIterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>,IPv4Address,C> blockSizeCachingAllNodeIterator()
```
    Description copied from class: AddressTrie
    
    Iterates all nodes, ordered by keys from largest prefix blocks to smallest, and then to individual addresses.
    This iterator supports the Iterator.remove() operation.
    
    Overrides:
    
    blockSizeCachingAllNodeIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - containingFirstIterator
```
public Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> containingFirstIterator(boolean forwardSubNodeOrder)
```
    Description copied from interface: TreeOps
    
    Returns an iterator that does a pre-order binary tree traversal of the added nodes. All added nodes will be visited before their added sub-nodes. For an address trie this means added containing subnet blocks will be visited before their added contained addresses and subnet blocks.
    This iterator supports the Iterator.remove() operation.
    See the docs for TreeOps for more details on the ordering.
    
    Specified by:
    
    containingFirstIterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    containingFirstIterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    containingFirstIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.
    
    Returns:
  - containingFirstAllNodeIterator
```
public <C> BinaryTreeNode.CachingIterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>,IPv4Address,C> containingFirstAllNodeIterator(boolean forwardSubNodeOrder)
```
    Description copied from interface: TreeOps
    Returns an iterator that does a pre-order binary tree traversal. All nodes will be visited before their sub-nodes. For an address trie this means containing subnet blocks will be visited before their contained addresses and subnet blocks.
    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.
    Specified by:
    
    containingFirstAllNodeIterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    containingFirstAllNodeIterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    containingFirstAllNodeIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.
    
    Returns:
  - containedFirstIterator
```
public Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> containedFirstIterator(boolean forwardSubNodeOrder)
```
    Description copied from interface: TreeOps
    
    Returns an iterator that does a post-order binary tree traversal of the added nodes. All added sub-nodes will be visited before their parent nodes. For an address trie this means contained addresses and subnets will be visited before their containing subnet blocks.
    This iterator supports the Iterator.remove() operation.
    See TreeOps for more details on the ordering.
    
    Specified by:
    
    containedFirstIterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    containedFirstIterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    containedFirstIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.
    
    Returns:
  - containedFirstAllNodeIterator
```
public Iterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> containedFirstAllNodeIterator(boolean forwardSubNodeOrder)
```
    Description copied from interface: TreeOps
    
    Returns an iterator that does a post-order binary tree traversal. All sub-nodes will be visited before their parent nodes. For an address trie this means contained addresses and subnets will be visited before their containing subnet blocks.
    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.
    
    Specified by:
    
    containedFirstAllNodeIterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    containedFirstAllNodeIterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    containedFirstAllNodeIterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forwardSubNodeOrder - if true, a left sub-node will be visited before the right sub-node of the same parent node.
    
    Returns:
  - nodeSpliterator
```
public Spliterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> nodeSpliterator(boolean forward)
```
    Description copied from interface: TreeOps
    
    Creates a Spliterator over the added nodes in forward or reverse natural tree order.
    See TreeOps for more details on the ordering.
    
    Specified by:
    
    nodeSpliterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    nodeSpliterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    nodeSpliterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - allNodeSpliterator
```
public Spliterator<IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V>> allNodeSpliterator(boolean forward)
```
    Description copied from interface: TreeOps
    
    Creates a Spliterator over the nodes in forward or reverse natural tree order.
    See TreeOps for more details on the ordering.
    
    Specified by:
    
    allNodeSpliterator in interface AddressTrieOps<IPv4Address>
    
    Specified by:
    
    allNodeSpliterator in interface TreeOps<IPv4Address>
    
    Overrides:
    
    allNodeSpliterator in class AssociativeAddressTrie<IPv4Address,V>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - lowerAddedNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> lowerAddedNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Returns the added node whose address is the highest address strictly less than the given address.
    
    Specified by:
    
    lowerAddedNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    lowerAddedNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - floorAddedNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> floorAddedNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Returns the added node whose address is the highest address less than or equal to the given address.
    
    Specified by:
    
    floorAddedNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    floorAddedNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - higherAddedNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> higherAddedNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Returns the added node whose address is the lowest address strictly greater than the given address.
    
    Specified by:
    
    higherAddedNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    higherAddedNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - ceilingAddedNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> ceilingAddedNode(IPv4Address addr)
```
    Description copied from interface: AddressTrieOps
    
    Returns the added node whose address is the lowest address greater than or equal to the given address.
    
    Specified by:
    
    ceilingAddedNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    ceilingAddedNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - firstNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> firstNode()
```
    Description copied from interface: AddressTrieOps
    
    Returns the node with the first (lowest valued) key, whether the node is added or not
    
    Specified by:
    
    firstNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    firstNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - lastNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> lastNode()
```
    Description copied from interface: AddressTrieOps
    
    Returns the node with the last (highest valued) key, whether the node is added or not
    
    Specified by:
    
    lastNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    lastNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - firstAddedNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> firstAddedNode()
```
    Description copied from interface: AddressTrieOps
    
    Returns the added node with the first (lowest valued) key, or null if there are no added entries in this trie or subtrie
    
    Specified by:
    
    firstAddedNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    firstAddedNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - lastAddedNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> lastAddedNode()
```
    Description copied from interface: AddressTrieOps
    
    Returns the added node with the last (highest valued) key, or null if there are no added elements in this trie or subtrie
    
    Specified by:
    
    lastAddedNode in interface AddressTrieOps<IPv4Address>
    
    Overrides:
    
    lastAddedNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - putNode
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> putNode(IPv4Address addr,
                                                                     V value)
```
    Description copied from interface: AddressTrieOps.AssociativeAddressTriePutOps
    
    Associates the specified value with the specified key in this map.
    Unlike AddressTrieOps.AssociativeAddressTriePutOps.put(Address, Object), AddressTrieOps.AssociativeAddressTriePutOps.put(Address, Object) can distinguish between cases where the call results in a new entry, and cases where the call matched a previous entry that was mapped to null.
    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 node for the added address, whether it was already in the tree or not.
    If you wish to know whether the node was already there when adding, use AddressTrieOps.AssociativeAddressTriePutOps.putNew(Address, Object), or before adding you can use AddressTrieOps.getAddedNode(Address)
    
    Specified by:
    
    putNode in interface AddressTrieOps.AssociativeAddressTriePutOps<IPv4Address,V>
    
    Overrides:
    
    putNode in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - putTrie
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> putTrie(AssociativeAddressTrie.AssociativeTrieNode<IPv4Address,V> trie)
```
    Description copied from interface: AddressTrieOps.AssociativeAddressTriePutOps
    
    Adds nodes matching the given sub-root node and all of its sub-nodes to the trie, if not already there.
    For each added in the given node that does not exist in the trie, a copy of each node will be made that matches the trie type (associative or not), the copy including the associated value, and the copy will be inserted into the trie.
    The node type need not match the node type of the trie, although the address type/version E must match. So this means you can add non-associative nodes with this method, in which case, the new nodes will be associative but will be mapped to null.
    When adding one trie to another, this method is more efficient than adding each node of the first trie individually. When using this method, searching for the location to add sub-nodes starts from the inserted parent node.
    Returns the node corresponding to the given sub-root node, whether it was already in the trie or not.
    
    Specified by:
    
    putTrie in interface AddressTrieOps.AssociativeAddressTriePutOps<IPv4Address,V>
    
    Overrides:
    
    putTrie in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - remap
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> remap(IPv4Address addr,
                                                                   Function<? super V,? extends V> remapper)
```
    Description copied from interface: AddressTrieOps.AssociativeAddressTriePutOps
    
    Remaps node values in the trie.
    This will lookup the node corresponding to the given key. It will call the remapping function with the key as the first argument, regardless of whether the node is found or not.
    If the node is not found, the value argument will be null. If the node is found, the value argument will be the node's value, which can also be null.
    If the remapping function returns null, then the matched node will be removed, if any. If it returns a non-null value, then it will either set the existing node to have that value, or if there was no matched node, it will create a new node with that value.
    The method will return the node involved, which is either the matched node, or the newly created node, or null if there was no matched node nor newly created node.
    If the remapping function modifies the trie during its computation, and the returned value specifies changes to be made, then the trie will not be changed and ConcurrentModificationException will be thrown instead.
    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.
    
    Specified by:
    
    remap in interface AddressTrieOps.AssociativeAddressTriePutOps<IPv4Address,V>
    
    Overrides:
    
    remap in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - remapIfAbsent
```
public IPv4AddressAssociativeTrie.IPv4AssociativeTrieNode<V> remapIfAbsent(IPv4Address addr,
                                                                           Supplier<? extends V> remapper,
                                                                           boolean insertNull)
```
    Description copied from interface: AddressTrieOps.AssociativeAddressTriePutOps
    
    Remaps node values in the trie, but only for nodes that do not exist or are mapped to null.
    This will look up the node corresponding to the given key. If the node is not found or mapped to null, this will call the remapping function.
    If the remapping function returns a non-null value, then it will either set the existing node to have that value, or if there was no matched node, it will create a new node with that value. If the remapping function returns null, then it will do the same if insertNull is true, otherwise it will do nothing.
    The method will return the node involved, which is either the matched node, or the newly created node, or null if there was no matched node nor newly created node.
    If the remapping function modifies the trie during its computation, and the returned value specifies changes to be made, then the trie will not be changed and ConcurrentModificationException will be thrown instead.
    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.
    
    Specified by:
    
    remapIfAbsent in interface AddressTrieOps.AssociativeAddressTriePutOps<IPv4Address,V>
    
    Overrides:
    
    remapIfAbsent in class AssociativeAddressTrie<IPv4Address,V>
    
    insertNull - whether null values returned from remapper should be inserted into the map, or whether null values indicate no remapping
    
    Returns:
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: AddressTrie
    
    Returns whether the given argument is a trie with a set of nodes that equal the set of nodes in this trie
    
    Overrides:
    
    equals in class AssociativeAddressTrie<IPv4Address,V>
  - clone
```
public IPv4AddressAssociativeTrie<V> clone()
```
    Copies the trie, but not the keys or values.
    
    Overrides:
    
    clone in class AssociativeAddressTrie<IPv4Address,V>
  - constructAddedNodesTree
```
public AssociativeAddedTree<IPv4Address,V> constructAddedNodesTree()
```
    Description copied from class: AddressTrie
    
    Provides an associative trie in which the root and each added node are mapped to a list of their respective direct added nodes. This trie provides an alternative non-binary tree structure of the added nodes. It is used by AddressTrie.toAddedNodesTreeString() to produce a string showing the alternative structure. If there are no non-added nodes in this trie, then the alternative tree structure provided by this method is the same as the original trie.
    
    Specified by:
    
    constructAddedNodesTree in class AssociativeAddressTrie<IPv4Address,V>
    
    Returns:
  - toAddedNodesTreeString
```
public String toAddedNodesTreeString()
```
    Description copied from class: AddressTrie
    
    Provides a flattened version of the trie showing only the contained added nodes and their containment structure, which is non-binary. The root node is included, which may or may not be added.
    See AddressTrie.constructAddedNodesTree()
    
    Specified by:
    
    toAddedNodesTreeString in class AddressTrie<IPv4Address>
    
    Returns:
  - iterator
```
public Iterator<E> iterator()
```
    Description copied from interface: TreeOps
    
    Traverses the added node keys in natural tree order.
    This iterator supports the Iterator.remove() operation.
    See TreeOps for more details on the ordering.
    
    Specified by:
    
    iterator in interface TreeOps<E extends Address>
    
    Specified by:
    
    iterator in interface Iterable<E extends Address>
  - descendingIterator
```
public Iterator<E> descendingIterator()
```
    Description copied from interface: TreeOps
    
    Traverses the added node keys in reverse natural tree order.
    This iterator supports the Iterator.remove() operation.
    See TreeOps for more details on the ordering.
    
    Specified by:
    
    descendingIterator in interface TreeOps<E extends Address>
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class IPv4AddressAssociativeTrie<V>

Nested Class Summary

Nested classes/interfaces inherited from class inet.ipaddr.format.util.AssociativeAddressTrie

Nested classes/interfaces inherited from class inet.ipaddr.format.util.AddressTrie

Nested classes/interfaces inherited from interface inet.ipaddr.format.util.AddressTrieOps

Constructor Summary

Method Summary

Methods inherited from class inet.ipaddr.format.util.AssociativeAddressTrie

Methods inherited from class inet.ipaddr.format.util.AddressTrie

Methods inherited from class java.lang.Object

Methods inherited from interface inet.ipaddr.format.util.AddressTrieOps

Methods inherited from interface inet.ipaddr.format.util.TreeOps

Methods inherited from interface java.lang.Iterable

Constructor Detail

IPv4AddressAssociativeTrie

Method Detail

getRoot

removeElementsContainedBy

elementsContainedBy

elementsContaining

longestPrefixMatchNode

getAddedNode

getNode

addNode

addTrie

nodeIterator

allNodeIterator

blockSizeNodeIterator

blockSizeAllNodeIterator

blockSizeCachingAllNodeIterator

containingFirstIterator

containingFirstAllNodeIterator

containedFirstIterator

containedFirstAllNodeIterator

nodeSpliterator

allNodeSpliterator

lowerAddedNode

floorAddedNode

higherAddedNode

ceilingAddedNode

firstNode

lastNode

firstAddedNode

lastAddedNode

putNode

putTrie

remap

remapIfAbsent

equals

clone

constructAddedNodesTree

toAddedNodesTreeString

iterator

descendingIterator

hashCode