org.onlab.util

Class ExtendedSet<E>

java.lang.Object

org.onlab.util.ExtendedSet<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>

public class ExtendedSet<E>
extends Object
implements Set<E>

A Set providing additional get, insertOrReplace and conditionalRemove methods.

Constructor Summary

Constructors

Constructor and Description
ExtendedSet(Map<E,E> map) Constructs a new instance by backing it with the supplied Map.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	conditionalRemove(E entry, Predicate<E> entryTest) Removes the entry if the supplied predicate evaluates to true.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
E	get(Object o) Returns set element that is equal to the specified object.
boolean	insertOrReplace(E entry, Predicate<E> entryTest) Inserts the entry if it is not already in the set otherwise replaces the existing entry if the supplied predicate evaluates to true.
boolean	isEmpty()
Iterator<E>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ExtendedSet

public ExtendedSet(Map<E,E> map)

Constructs a new instance by backing it with the supplied Map.

Constructed ExtendedSet will have the same concurrency properties as that of the supplied Map.

Parameters:

map - input map.

Method Detail

get

public E get(Object o)

Returns set element that is equal to the specified object.

Parameters:

o - object

Returns:

set element that is equal to the input argument or null if no such set element exists

insertOrReplace

public boolean insertOrReplace(E entry,
                               Predicate<E> entryTest)

Inserts the entry if it is not already in the set otherwise replaces the existing entry if the supplied predicate evaluates to true.

Parameters:

entry - entry to add

entryTest - predicate that is used to evaluate if the existing entry should be replaced

Returns:

true if the set is updated; false otherwise

conditionalRemove

public boolean conditionalRemove(E entry,
                                 Predicate<E> entryTest)

Removes the entry if the supplied predicate evaluates to true.

Parameters:

entry - entry to remove

entryTest - predicate that is used to evaluated aginst the existing entry. Return value of true implies value should be removed.

Returns:

true if the set is updated; false otherwise

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Set<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>