BaseDualIPv4v6Tries (IPAddress javadoc by seancfoley)

java.lang.Object
- inet.ipaddr.format.util.BaseDualIPv4v6Tries<T4,T6>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<IPAddress>

Direct Known Subclasses:

DualIPv4v6AssociativeTries, DualIPv4v6Tries
```
public abstract class BaseDualIPv4v6Tries<T4 extends AddressTrie<IPv4Address>,T6 extends AddressTrie<IPv6Address>>
extends Object
implements Iterable<IPAddress>, Serializable, Cloneable
```
Contains a pair of IPv4 and IPv6 tries for a data structure that can have fast look-up and containment checks of both IPv4 and IPv6 addresses. For a tree that is either IPv4 or IPv6, you can just use #AddressTrie.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(IPAddress addr)` Adds the given single address or prefix block subnet to one of the two tries.
`AddressTrie.TrieNode<? extends IPAddress>`	`addNode(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`addTrie(AddressTrie.TrieNode<? extends IPAddress> trie)`
`abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>>`	`blockSizeNodeIterator(boolean lowerSubNodeFirst)`
`IPAddress`	`ceiling(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`ceilingAddedNode(IPAddress addr)`
`BaseDualIPv4v6Tries<T4,T6>`	`clone()`
`abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>>`	`containedFirstIterator(boolean forwardSubNodeOrder)`
`abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>>`	`containingFirstIterator(boolean forwardSubNodeOrder)`
`boolean`	`contains(IPAddress addr)` Returns whether the given address or prefix block subnet is in one of the two tries (as an added element).
`Iterator<IPAddress>`	`descendingIterator()`
`Spliterator<IPAddress>`	`descendingSpliterator()`
`boolean`	`elementContains(IPAddress addr)` Checks if a prefix block subnet or address in ones of the two tries contains the given subnet or address.
`AddressTrie.TrieNode<? extends IPAddress>`	`elementsContainedBy(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`elementsContaining(IPAddress addr)`
`IPAddress`	`floor(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`floorAddedNode(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`getAddedNode(IPAddress addr)`
`abstract T4`	`getIPv4Trie()` returns the contained IPv4 trie
`abstract T6`	`getIPv6Trie()` returns the contained IPv6 trie
`IPAddress`	`higher(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`higherAddedNode(IPAddress addr)`
`boolean`	`isEmpty()` Returns true if there are no added nodes within the two tries
`Iterator<IPAddress>`	`iterator()`
`IPAddress`	`longestPrefixMatch(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`longestPrefixMatchNode(IPAddress addr)`
`IPAddress`	`lower(IPAddress addr)`
`AddressTrie.TrieNode<? extends IPAddress>`	`lowerAddedNode(IPAddress addr)`
`abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>>`	`nodeIterator(boolean forward)`
`abstract Spliterator<? extends AddressTrie.TrieNode<? extends IPAddress>>`	`nodeSpliterator(boolean forward)`
`boolean`	`remove(IPAddress addr)` Removes the given single address or prefix block subnet from the tries.
`AddressTrie.TrieNode<? extends IPAddress>`	`removeElementsContainedBy(IPAddress addr)`
`int`	`size()` Returns the number of elements in the tries.
`Spliterator<IPAddress>`	`spliterator()`
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - getIPv4Trie
```
public abstract T4 getIPv4Trie()
```
    returns the contained IPv4 trie
    
    Returns:
  - getIPv6Trie
```
public abstract T6 getIPv6Trie()
```
    returns the contained IPv6 trie
    
    Returns:
  - clone
```
public BaseDualIPv4v6Tries<T4,T6> clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - size
```
public int size()
```
    Returns the number of elements in the tries. Only added nodes are counted. When zero is returned, isEmpty() returns true.
    
    Returns:
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if there are no added nodes within the two tries
  - add
```
public boolean add(IPAddress addr)
```
    Adds the given single address or prefix block subnet to one of the two tries.
    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. Given a subnet s of type E and a trie of type AddressTrie<E>, such as IPv4Address and IPv4AddressTrie, you can convert and add the spanning prefix blocks with Partition.partitionWithSpanningBlocks(s).predicateForEach(trie::add), or you can convert and add using a single max block size with Partition.partitionWithSingleBlockSize(s).predicateForEach(trie::add).
    Returns true if the prefix block or address was inserted, false if already in one of the two tries.
    
    Parameters:
    
    addr -
    
    Returns:
  - contains
```
public boolean contains(IPAddress addr)
```
    Returns whether the given address or prefix block subnet is in one of the two tries (as an added element).
    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 one the two tries, false otherwise.
    Use getAddedNode(IPAddress) to get the node for the address rather than just checking for its existence.
    
    Parameters:
    
    addr -
    
    Returns:
  - remove
```
public boolean remove(IPAddress addr)
```
    Removes the given single address or prefix block subnet from the tries.
    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 one of the two tries.
    You can also remove by calling getAddedNode(IPAddress) 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.
    
    Parameters:
    
    addr -
    
    Returns:
    
    See Also:
    
    removeElementsContainedBy(IPAddress)
  - elementContains
```
public boolean elementContains(IPAddress addr)
```
    Checks if a prefix block subnet or address in ones of the two tries contains the given subnet or 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 true if the subnet or address is contained by a trie element, false otherwise.
    To get all the containing addresses, use elementsContaining(IPAddress).
    
    Parameters:
    
    addr -
    
    Returns:
  - elementsContaining
```
public AddressTrie.TrieNode<? extends IPAddress> elementsContaining(IPAddress addr)
```
  - elementsContainedBy
```
public AddressTrie.TrieNode<? extends IPAddress> elementsContainedBy(IPAddress addr)
```
  - removeElementsContainedBy
```
public AddressTrie.TrieNode<? extends IPAddress> removeElementsContainedBy(IPAddress addr)
```
  - getAddedNode
```
public AddressTrie.TrieNode<? extends IPAddress> getAddedNode(IPAddress addr)
```
  - longestPrefixMatchNode
```
public AddressTrie.TrieNode<? extends IPAddress> longestPrefixMatchNode(IPAddress addr)
```
  - longestPrefixMatch
```
public IPAddress longestPrefixMatch(IPAddress addr)
```
  - addNode
```
public AddressTrie.TrieNode<? extends IPAddress> addNode(IPAddress addr)
```
  - addTrie
```
public AddressTrie.TrieNode<? extends IPAddress> addTrie(AddressTrie.TrieNode<? extends IPAddress> trie)
```
  - floorAddedNode
```
public AddressTrie.TrieNode<? extends IPAddress> floorAddedNode(IPAddress addr)
```
  - lowerAddedNode
```
public AddressTrie.TrieNode<? extends IPAddress> lowerAddedNode(IPAddress addr)
```
  - ceilingAddedNode
```
public AddressTrie.TrieNode<? extends IPAddress> ceilingAddedNode(IPAddress addr)
```
  - higherAddedNode
```
public AddressTrie.TrieNode<? extends IPAddress> higherAddedNode(IPAddress addr)
```
  - floor
```
public IPAddress floor(IPAddress addr)
```
  - lower
```
public IPAddress lower(IPAddress addr)
```
  - ceiling
```
public IPAddress ceiling(IPAddress addr)
```
  - higher
```
public IPAddress higher(IPAddress addr)
```
  - iterator
```
public Iterator<IPAddress> iterator()
```
    Specified by:
    
    iterator in interface Iterable<IPAddress>
  - descendingIterator
```
public Iterator<IPAddress> descendingIterator()
```
  - spliterator
```
public Spliterator<IPAddress> spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<IPAddress>
  - descendingSpliterator
```
public Spliterator<IPAddress> descendingSpliterator()
```
  - nodeIterator
```
public abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>> nodeIterator(boolean forward)
```
  - containingFirstIterator
```
public abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>> containingFirstIterator(boolean forwardSubNodeOrder)
```
  - containedFirstIterator
```
public abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>> containedFirstIterator(boolean forwardSubNodeOrder)
```
  - blockSizeNodeIterator
```
public abstract Iterator<? extends AddressTrie.TrieNode<? extends IPAddress>> blockSizeNodeIterator(boolean lowerSubNodeFirst)
```
  - nodeSpliterator
```
public abstract Spliterator<? extends AddressTrie.TrieNode<? extends IPAddress>> nodeSpliterator(boolean forward)
```

Class BaseDualIPv4v6Tries<T4 extends AddressTrie<IPv4Address>,T6 extends AddressTrie<IPv6Address>>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

getIPv4Trie

getIPv6Trie

clone

toString

size

isEmpty

add

contains

remove

elementContains

elementsContaining

elementsContainedBy

removeElementsContainedBy

getAddedNode

longestPrefixMatchNode

longestPrefixMatch

addNode

addTrie

floorAddedNode

lowerAddedNode

ceilingAddedNode

higherAddedNode

floor

lower

ceiling

higher

iterator

descendingIterator

spliterator

descendingSpliterator

nodeIterator

containingFirstIterator

containedFirstIterator

blockSizeNodeIterator

nodeSpliterator