MACAddressTrie.MACTrieNode (IPAddress javadoc by seancfoley)

java.lang.Object
- inet.ipaddr.format.util.BinaryTreeNode<E>
- - inet.ipaddr.format.util.AddressTrie.TrieNode<MACAddress>
  - - inet.ipaddr.mac.MACAddressTrie.MACTrieNode

All Implemented Interfaces:

AddressTrieOps<MACAddress>, TreeOps<MACAddress>, Serializable, Cloneable, Iterable<MACAddress>

Enclosing class:

MACAddressTrie
```
public static class MACAddressTrie.MACTrieNode
extends AddressTrie.TrieNode<MACAddress>
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class inet.ipaddr.format.util.BinaryTreeNode
  BinaryTreeNode.CachingIterator<N extends BinaryTreeNode<E>,E,C>
- 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>

Constructor Summary

Constructors
Constructor and Description

MACTrieNode()

Constructors
Constructor and Description
`MACTrieNode()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Iterator<MACAddressTrie.MACTrieNode>`	`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<MACAddressTrie.MACTrieNode>`	`allNodeSpliterator(boolean forward)` Creates a `Spliterator` over the nodes in forward or reverse natural tree order.
`MACAddressTrie`	`asNewTrie()` Creates a new sub-trie, copying the nodes starting with this node as root.
`Iterator<MACAddressTrie.MACTrieNode>`	`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<MACAddressTrie.MACTrieNode,MACAddress,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<MACAddressTrie.MACTrieNode>`	`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.
`MACAddressTrie.MACTrieNode`	`ceilingAddedNode(MACAddress addr)` Returns the added node whose address is the lowest address greater than or equal to the given address.
`MACAddressTrie.MACTrieNode`	`clone()` Clones the node.
`MACAddressTrie.MACTrieNode`	`cloneTree()` Clones the sub-tree starting with this node as root.
`Iterator<MACAddressTrie.MACTrieNode>`	`containedFirstAllNodeIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a post-order binary tree traversal.
`Iterator<MACAddressTrie.MACTrieNode>`	`containedFirstIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a post-order binary tree traversal of the added nodes.
`<C> BinaryTreeNode.CachingIterator<MACAddressTrie.MACTrieNode,MACAddress,C>`	`containingFirstAllNodeIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a pre-order binary tree traversal.
`<C> BinaryTreeNode.CachingIterator<MACAddressTrie.MACTrieNode,MACAddress,C>`	`containingFirstIterator(boolean forwardSubNodeOrder)` Returns an iterator that does a pre-order binary tree traversal of the added nodes.
`MACAddressTrie.MACTrieNode`	`elementsContainedBy(MACAddress addr)` Checks if a part of this trie is contained by the given prefix block subnet or individual address.
`MACAddressTrie.MACTrieNode`	`elementsContaining(MACAddress 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
`MACAddressTrie.MACTrieNode`	`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
`MACAddressTrie.MACTrieNode`	`firstNode()` Returns the first (lowest valued) node in the sub-tree originating from this node.
`MACAddressTrie.MACTrieNode`	`floorAddedNode(MACAddress addr)` Returns the added node whose address is the highest address less than or equal to the given address.
`MACAddressTrie.MACTrieNode`	`getAddedNode(MACAddress addr)` Gets trie nodes representing added elements.
`MACAddressTrie.MACTrieNode`	`getLowerSubNode()` Returns the sub node whose address is smallest in value
`MACAddressTrie.MACTrieNode`	`getNode(MACAddress addr)` Gets the node corresponding to the given address, returns null if not such element exists.
`MACAddressTrie.MACTrieNode`	`getParent()` Returns the node for the subnet block containing this node.
`MACAddressTrie.MACTrieNode`	`getUpperSubNode()` Returns the sub-node whose address is largest in value
`MACAddressTrie.MACTrieNode`	`higherAddedNode(MACAddress addr)` Returns the added node whose address is the lowest address strictly greater than the given address.
`MACAddressTrie.MACTrieNode`	`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
`MACAddressTrie.MACTrieNode`	`lastNode()` Returns the last (highest valued) node in the sub-tree originating from this node.
`MACAddressTrie.MACTrieNode`	`longestPrefixMatchNode(MACAddress 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.
`MACAddressTrie.MACTrieNode`	`lowerAddedNode(MACAddress addr)` Returns the added node whose address is the highest address strictly less than the given address.
`MACAddressTrie.MACTrieNode`	`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.
`MACAddressTrie.MACTrieNode`	`nextNode()` Returns the node that follows this node following the tree order
`Iterator<MACAddressTrie.MACTrieNode>`	`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<MACAddressTrie.MACTrieNode>`	`nodeSpliterator(boolean forward)` Creates a `Spliterator` over the added nodes in forward or reverse natural tree order.
`MACAddressTrie.MACTrieNode`	`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.
`MACAddressTrie.MACTrieNode`	`previousNode()` Returns the node that precedes this node following the tree order.
`MACAddressTrie.MACTrieNode`	`removeElementsContainedBy(MACAddress addr)` Removes any single address or prefix block subnet from the trie that is contained in the given individual address or prefix block subnet.

Methods inherited from class inet.ipaddr.format.util.AddressTrie.TrieNode
ceiling, contains, descendingSpliterator, elementContains, floor, higher, longestPrefixMatch, lower, remove, shortestPrefixMatch, shortestPrefixMatchNode, spliterator

Methods inherited from class inet.ipaddr.format.util.BinaryTreeNode
clear, descendingIterator, getKey, hashCode, isAdded, isEmpty, isLeaf, isRoot, iterator, nodeSize, remove, setAdded, size, toString, toTreeString, treeEquals, treeHashCode

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

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

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - MACTrieNode
```
public MACTrieNode()
```
- Method Detail
  - getUpperSubNode
```
public MACAddressTrie.MACTrieNode getUpperSubNode()
```
    Description copied from class: AddressTrie.TrieNode
    
    Returns the sub-node whose address is largest in value
    
    Overrides:
    
    getUpperSubNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - getLowerSubNode
```
public MACAddressTrie.MACTrieNode getLowerSubNode()
```
    Description copied from class: AddressTrie.TrieNode
    
    Returns the sub node whose address is smallest in value
    
    Overrides:
    
    getLowerSubNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - getParent
```
public MACAddressTrie.MACTrieNode getParent()
```
    Description copied from class: AddressTrie.TrieNode
    
    Returns the node for the subnet block containing this node.
    
    Overrides:
    
    getParent in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - removeElementsContainedBy
```
public MACAddressTrie.MACTrieNode removeElementsContainedBy(MACAddress 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<MACAddress>
    
    Overrides:
    
    removeElementsContainedBy in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - elementsContainedBy
```
public MACAddressTrie.MACTrieNode elementsContainedBy(MACAddress 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<MACAddress>
    
    Overrides:
    
    elementsContainedBy in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - elementsContaining
```
public MACAddressTrie.MACTrieNode elementsContaining(MACAddress 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<MACAddress>
    
    Overrides:
    
    elementsContaining in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - longestPrefixMatchNode
```
public MACAddressTrie.MACTrieNode longestPrefixMatchNode(MACAddress 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<MACAddress>
    
    Overrides:
    
    longestPrefixMatchNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - getAddedNode
```
public MACAddressTrie.MACTrieNode getAddedNode(MACAddress 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.
    
    Returns:
  - getNode
```
public MACAddressTrie.MACTrieNode getNode(MACAddress 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<MACAddress>
    
    Overrides:
    
    getNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
    
    See Also:
    
    AddressTrieOps.contains(Address)
  - nodeIterator
```
public Iterator<MACAddressTrie.MACTrieNode> nodeIterator(boolean forward)
```
    Description copied from class: BinaryTreeNode
    
    Iterates through the added nodes of the sub-tree with this node as the root, in forward or reverse tree order.
    
    Specified by:
    
    nodeIterator in interface AddressTrieOps<MACAddress>
    
    Specified by:
    
    nodeIterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    nodeIterator in class AddressTrie.TrieNode<MACAddress>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - allNodeIterator
```
public Iterator<MACAddressTrie.MACTrieNode> allNodeIterator(boolean forward)
```
    Description copied from class: BinaryTreeNode
    
    Iterates through all the nodes of the sub-tree with this node as the root, in forward or reverse tree order.
    
    Specified by:
    
    allNodeIterator in interface AddressTrieOps<MACAddress>
    
    Specified by:
    
    allNodeIterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    allNodeIterator in class AddressTrie.TrieNode<MACAddress>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - blockSizeNodeIterator
```
public Iterator<MACAddressTrie.MACTrieNode> blockSizeNodeIterator(boolean lowerSubNodeFirst)
```
    Description copied from class: AddressTrie.TrieNode
    
    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.
    This iterator supports the Iterator.remove() operation.
    
    Overrides:
    
    blockSizeNodeIterator in class AddressTrie.TrieNode<MACAddress>
    
    Parameters:
    
    lowerSubNodeFirst - if true, for blocks of equal size the lower is first, otherwise the reverse order
    
    Returns:
  - blockSizeAllNodeIterator
```
public Iterator<MACAddressTrie.MACTrieNode> blockSizeAllNodeIterator(boolean lowerSubNodeFirst)
```
    Description copied from class: AddressTrie.TrieNode
    
    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.
    This iterator supports the Iterator.remove() operation.
    
    Overrides:
    
    blockSizeAllNodeIterator in class AddressTrie.TrieNode<MACAddress>
    
    Parameters:
    
    lowerSubNodeFirst - if true, for blocks of equal size the lower is first, otherwise the reverse order
    
    Returns:
  - blockSizeCachingAllNodeIterator
```
public <C> BinaryTreeNode.CachingIterator<MACAddressTrie.MACTrieNode,MACAddress,C> blockSizeCachingAllNodeIterator()
```
    Description copied from class: AddressTrie.TrieNode
    
    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.
    
    Overrides:
    
    blockSizeCachingAllNodeIterator in class AddressTrie.TrieNode<MACAddress>
  - containingFirstIterator
```
public <C> BinaryTreeNode.CachingIterator<MACAddressTrie.MACTrieNode,MACAddress,C> 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.
    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.
    
    Specified by:
    
    containingFirstIterator in interface AddressTrieOps<MACAddress>
    
    Specified by:
    
    containingFirstIterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    containingFirstIterator in class AddressTrie.TrieNode<MACAddress>
    
    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<MACAddressTrie.MACTrieNode,MACAddress,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<MACAddress>
    
    Specified by:
    
    containingFirstAllNodeIterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    containingFirstAllNodeIterator in class AddressTrie.TrieNode<MACAddress>
    
    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<MACAddressTrie.MACTrieNode> 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<MACAddress>
    
    Specified by:
    
    containedFirstIterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    containedFirstIterator in class AddressTrie.TrieNode<MACAddress>
    
    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<MACAddressTrie.MACTrieNode> 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<MACAddress>
    
    Specified by:
    
    containedFirstAllNodeIterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    containedFirstAllNodeIterator in class AddressTrie.TrieNode<MACAddress>
    
    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<MACAddressTrie.MACTrieNode> 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<MACAddress>
    
    Specified by:
    
    nodeSpliterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    nodeSpliterator in class AddressTrie.TrieNode<MACAddress>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - allNodeSpliterator
```
public Spliterator<MACAddressTrie.MACTrieNode> 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<MACAddress>
    
    Specified by:
    
    allNodeSpliterator in interface TreeOps<MACAddress>
    
    Overrides:
    
    allNodeSpliterator in class AddressTrie.TrieNode<MACAddress>
    
    Parameters:
    
    forward - if true, goes in ascending order, otherwise descending
    
    Returns:
  - previousAddedNode
```
public MACAddressTrie.MACTrieNode previousAddedNode()
```
    Description copied from class: BinaryTreeNode
    
    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.
    
    Overrides:
    
    previousAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - nextAddedNode
```
public MACAddressTrie.MACTrieNode nextAddedNode()
```
    Description copied from class: BinaryTreeNode
    
    Returns the next node in the tree that is an added node, following the tree order, or null if there is no such node.
    
    Overrides:
    
    nextAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - nextNode
```
public MACAddressTrie.MACTrieNode nextNode()
```
    Description copied from class: BinaryTreeNode
    
    Returns the node that follows this node following the tree order
    
    Overrides:
    
    nextNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - previousNode
```
public MACAddressTrie.MACTrieNode previousNode()
```
    Description copied from class: BinaryTreeNode
    
    Returns the node that precedes this node following the tree order.
    
    Overrides:
    
    previousNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - lowerAddedNode
```
public MACAddressTrie.MACTrieNode lowerAddedNode(MACAddress 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<MACAddress>
    
    Overrides:
    
    lowerAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - floorAddedNode
```
public MACAddressTrie.MACTrieNode floorAddedNode(MACAddress 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<MACAddress>
    
    Overrides:
    
    floorAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - higherAddedNode
```
public MACAddressTrie.MACTrieNode higherAddedNode(MACAddress 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<MACAddress>
    
    Overrides:
    
    higherAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - ceilingAddedNode
```
public MACAddressTrie.MACTrieNode ceilingAddedNode(MACAddress 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<MACAddress>
    
    Overrides:
    
    ceilingAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - firstNode
```
public MACAddressTrie.MACTrieNode firstNode()
```
    Description copied from class: BinaryTreeNode
    
    Returns the first (lowest valued) node in the sub-tree originating from this node.
    
    Specified by:
    
    firstNode in interface AddressTrieOps<MACAddress>
    
    Overrides:
    
    firstNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - lastNode
```
public MACAddressTrie.MACTrieNode lastNode()
```
    Description copied from class: BinaryTreeNode
    
    Returns the last (highest valued) node in the sub-tree originating from this node.
    
    Specified by:
    
    lastNode in interface AddressTrieOps<MACAddress>
    
    Overrides:
    
    lastNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - firstAddedNode
```
public MACAddressTrie.MACTrieNode firstAddedNode()
```
    Description copied from class: BinaryTreeNode
    
    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
    
    Specified by:
    
    firstAddedNode in interface AddressTrieOps<MACAddress>
    
    Overrides:
    
    firstAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - lastAddedNode
```
public MACAddressTrie.MACTrieNode lastAddedNode()
```
    Description copied from class: BinaryTreeNode
    
    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
    
    Specified by:
    
    lastAddedNode in interface AddressTrieOps<MACAddress>
    
    Overrides:
    
    lastAddedNode in class AddressTrie.TrieNode<MACAddress>
    
    Returns:
  - asNewTrie
```
public MACAddressTrie asNewTrie()
```
    Description copied from class: AddressTrie.TrieNode
    
    Creates a new sub-trie, copying the nodes starting with this node as root. The nodes are copies of the nodes in this sub-trie, but their keys and values are not copies.
    
    Overrides:
    
    asNewTrie in class AddressTrie.TrieNode<MACAddress>
  - cloneTree
```
public MACAddressTrie.MACTrieNode cloneTree()
```
    Description copied from class: BinaryTreeNode
    
    Clones the sub-tree starting with this node as root. The nodes are cloned, but their keys and values are not cloned.
    
    Overrides:
    
    cloneTree in class AddressTrie.TrieNode<MACAddress>
  - clone
```
public MACAddressTrie.MACTrieNode clone()
```
    Description copied from class: BinaryTreeNode
    
    Clones the node. Keys remain the same, but the parent node and the lower and upper sub-nodes are all set to null.
    
    Overrides:
    
    clone in class AddressTrie.TrieNode<MACAddress>
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: BinaryTreeNode
    
    Returns whether the key values match those of the given node
    
    Overrides:
    
    equals in class AddressTrie.TrieNode<MACAddress>

Class MACAddressTrie.MACTrieNode

Nested Class Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

Constructor Detail

MACTrieNode

Method Detail

getUpperSubNode

getLowerSubNode

getParent

removeElementsContainedBy

elementsContainedBy

elementsContaining

longestPrefixMatchNode

getAddedNode

getNode

nodeIterator

allNodeIterator

blockSizeNodeIterator

blockSizeAllNodeIterator

blockSizeCachingAllNodeIterator

containingFirstIterator

containingFirstAllNodeIterator

containedFirstIterator

containedFirstAllNodeIterator

nodeSpliterator

allNodeSpliterator

previousAddedNode

nextAddedNode

nextNode

previousNode

lowerAddedNode

floorAddedNode

higherAddedNode

ceilingAddedNode

firstNode

lastNode

firstAddedNode

lastAddedNode

asNewTrie

cloneTree

clone

equals