inet.ipaddr.format.util

Class AddressTrieMap.EntrySet<K extends Address,V>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Map.Entry<K,V>>

inet.ipaddr.format.util.AddressTrieMap.EntrySet<K,V>

All Implemented Interfaces:

Serializable, Iterable<Map.Entry<K,V>>, Collection<Map.Entry<K,V>>, Set<Map.Entry<K,V>>

Enclosing class:

AddressTrieMap<K extends Address,V>

public static class AddressTrieMap.EntrySet<K extends Address,V>
extends AbstractSet<Map.Entry<K,V>>
implements Serializable

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Iterator<Map.Entry<K,V>>	blockSizeIterator() Iterates from largest prefix blocks to smallest to individual addresses.
void	clear() Removes all of the elements from this collection (optional operation).
Iterator<Map.Entry<K,V>>	containedFirstIterator() Returns an iterator that visits contained addresses and subnet blocks before their containing subnet blocks.
Iterator<Map.Entry<K,V>>	containingFirstIterator() Returns an iterator that visits containing subnet blocks before their contained addresses and subnet blocks.
boolean	contains(Object o) Returns true if this collection contains the specified element.
boolean	equals(Object o) Compares the specified object with this set for equality.
int	hashCode() Returns the hash code value for this set.
boolean	isEmpty() Returns true if this collection contains no elements.
Iterator<Map.Entry<K,V>>	iterator() Returns an iterator over the elements contained in this collection.
boolean	remove(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(Collection<?> collection) Removes from this set all of its elements that are contained in the specified collection (optional operation).
int	size() Returns the number of elements in this collection.
Spliterator<Map.Entry<K,V>>	spliterator() Creates a Spliterator over the elements in this set.

Methods inherited from class java.util.AbstractCollection

add, addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, containsAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

iterator

public Iterator<Map.Entry<K,V>> iterator()

Description copied from class: java.util.AbstractCollection

Returns an iterator over the elements contained in this collection.

Specified by:

iterator in interface Iterable<Map.Entry<K extends Address,V>>

Specified by:

iterator in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

iterator in interface Set<Map.Entry<K extends Address,V>>

Specified by:

iterator in class AbstractCollection<Map.Entry<K extends Address,V>>

Returns:

an iterator over the elements contained in this collection

containingFirstIterator

public Iterator<Map.Entry<K,V>> containingFirstIterator()

Returns an iterator that visits containing subnet blocks before their contained addresses and subnet blocks.

containedFirstIterator

public Iterator<Map.Entry<K,V>> containedFirstIterator()

Returns an iterator that visits contained addresses and subnet blocks before their containing subnet blocks.

Returns:

blockSizeIterator

public Iterator<Map.Entry<K,V>> blockSizeIterator()

Iterates from largest prefix blocks to smallest to individual addresses.

Returns:

spliterator

public Spliterator<Map.Entry<K,V>> spliterator()

Description copied from interface: java.util.Set

Creates a Spliterator over the elements in this set.

The Spliterator reports Spliterator.DISTINCT. Implementations should document the reporting of additional characteristic values.

Specified by:

spliterator in interface Iterable<Map.Entry<K extends Address,V>>

Specified by:

spliterator in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

spliterator in interface Set<Map.Entry<K extends Address,V>>

Returns:

a Spliterator over the elements in this set

size

public int size()

Description copied from interface: java.util.Collection

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

size in interface Set<Map.Entry<K extends Address,V>>

Specified by:

size in class AbstractCollection<Map.Entry<K extends Address,V>>

Returns:

the number of elements in this collection

isEmpty

public boolean isEmpty()

Description copied from class: java.util.AbstractCollection

Returns true if this collection contains no elements.

This implementation returns size() == 0.

Specified by:

isEmpty in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

isEmpty in interface Set<Map.Entry<K extends Address,V>>

Overrides:

isEmpty in class AbstractCollection<Map.Entry<K extends Address,V>>

Returns:

true if this collection contains no elements

contains

public boolean contains(Object o)

Description copied from class: java.util.AbstractCollection

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.

Specified by:

contains in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

contains in interface Set<Map.Entry<K extends Address,V>>

Overrides:

contains in class AbstractCollection<Map.Entry<K extends Address,V>>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

remove

public boolean remove(Object o)

Description copied from class: java.util.AbstractCollection

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.

Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.

Specified by:

remove in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

remove in interface Set<Map.Entry<K extends Address,V>>

Overrides:

remove in class AbstractCollection<Map.Entry<K extends Address,V>>

Parameters:

o - element to be removed from this collection, if present

Returns:

true if an element was removed as a result of this call

clear

public void clear()

Description copied from class: java.util.AbstractCollection

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.

Specified by:

clear in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

clear in interface Set<Map.Entry<K extends Address,V>>

Overrides:

clear in class AbstractCollection<Map.Entry<K extends Address,V>>

hashCode

public int hashCode()

Description copied from class: java.util.AbstractSet

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode().

This implementation iterates over the set, calling the hashCode method on each element in the set, and adding up the results.

Specified by:

hashCode in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

hashCode in interface Set<Map.Entry<K extends Address,V>>

Overrides:

hashCode in class AbstractSet<Map.Entry<K extends Address,V>>

Returns:

the hash code value for this set

See Also:

Object.equals(Object), Set.equals(Object)

equals

public boolean equals(Object o)

Description copied from class: java.util.AbstractSet

Compares the specified object with this set for equality. Returns true if the given object is also a set, the two sets have the same size, and every member of the given set is contained in this set. This ensures that the equals method works properly across different implementations of the Set interface.

This implementation first checks if the specified object is this set; if so it returns true. Then, it checks if the specified object is a set whose size is identical to the size of this set; if not, it returns false. If so, it returns containsAll((Collection) o).

Specified by:

equals in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

equals in interface Set<Map.Entry<K extends Address,V>>

Overrides:

equals in class AbstractSet<Map.Entry<K extends Address,V>>

Parameters:

o - object to be compared for equality with this set

Returns:

true if the specified object is equal to this set

See Also:

Object.hashCode(), HashMap

removeAll

public boolean removeAll(Collection<?> collection)

Description copied from class: java.util.AbstractSet

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.

Specified by:

removeAll in interface Collection<Map.Entry<K extends Address,V>>

Specified by:

removeAll in interface Set<Map.Entry<K extends Address,V>>

Overrides:

removeAll in class AbstractSet<Map.Entry<K extends Address,V>>

Parameters:

collection - collection containing elements to be removed from this set

Returns:

true if this set changed as a result of the call

See Also:

AbstractCollection.remove(Object), AbstractCollection.contains(Object)