it.unimi.dsi.fastutil.objects
Class ObjectArraySet<K>

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>
      extended by it.unimi.dsi.fastutil.objects.AbstractObjectSet<K>
          extended by it.unimi.dsi.fastutil.objects.ObjectArraySet<K>
All Implemented Interfaces:
ObjectCollection<K>, ObjectIterable<K>, ObjectSet<K>, Serializable, Cloneable, Iterable<K>, Collection<K>, Set<K>

public class ObjectArraySet<K>
extends AbstractObjectSet<K>
implements Serializable, Cloneable

A simple, brute-force implementation of a set based on a backing array.

The main purpose of this implementation is that of wrapping cleanly the brute-force approach to the storage of a very small number of items: just put them into an array and scan linearly to find an item.

See Also:
Serialized Form

Constructor Summary
ObjectArraySet()
          Creates a new empty array set.
ObjectArraySet(int capacity)
          Creates a new empty array set of given initial capacity.
ObjectArraySet(Object[] a)
          Creates a new array set using the given backing array.
ObjectArraySet(Object[] a, int size)
          Creates a new array set using the given backing array and the given number of elements of the array.
ObjectArraySet(ObjectSet<K> s)
          Creates a new array set copying the contents of a given set.
 
Method Summary
 boolean add(K k)
           
 void clear()
           
 Object clone()
          Returns a deep copy of this set.
 boolean contains(Object k)
           
 boolean isEmpty()
           
 ObjectIterator<K> iterator()
          Returns a type-specific iterator on the elements of this collection.
 boolean remove(Object k)
          Removes an element from this set.
 int size()
           
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectSet
equals, hashCode
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectCollection
addAll, containsAll, objectIterator, removeAll, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectCollection
objectIterator, toArray
 
Methods inherited from interface java.util.Set
addAll, containsAll, removeAll, retainAll, toArray, toArray
 

Constructor Detail

ObjectArraySet

public ObjectArraySet(Object[] a)
Creates a new array set using the given backing array.

Parameters:
a - the backing array.

ObjectArraySet

public ObjectArraySet()
Creates a new empty array set.


ObjectArraySet

public ObjectArraySet(int capacity)
Creates a new empty array set of given initial capacity.

Parameters:
capacity - the initial capacity.

ObjectArraySet

public ObjectArraySet(ObjectSet<K> s)
Creates a new array set copying the contents of a given set.


ObjectArraySet

public ObjectArraySet(Object[] a,
                      int size)
Creates a new array set using the given backing array and the given number of elements of the array.

It is responsibility of the caller that the first size elements of a are distinct (of course, distinct by identity, not by Object.equals(Object)).

Parameters:
a - the backing array.
size - the number of valid elements in a.
Method Detail

iterator

public ObjectIterator<K> iterator()
Description copied from interface: ObjectCollection
Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:
iterator in interface ObjectCollection<K>
Specified by:
iterator in interface ObjectIterable<K>
Specified by:
iterator in interface ObjectSet<K>
Specified by:
iterator in interface Iterable<K>
Specified by:
iterator in interface Collection<K>
Specified by:
iterator in interface Set<K>
Specified by:
iterator in class AbstractObjectSet<K>
Returns:
a type-specific iterator on the elements of this collection.

contains

public boolean contains(Object k)
Specified by:
contains in interface Collection<K>
Specified by:
contains in interface Set<K>

size

public int size()
Specified by:
size in interface Collection<K>
Specified by:
size in interface Set<K>

remove

public boolean remove(Object k)
Description copied from interface: ObjectSet
Removes an element from this set.

Note that the corresponding method of the type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface.

Specified by:
remove in interface ObjectSet<K>
Specified by:
remove in interface Collection<K>
Specified by:
remove in interface Set<K>
Overrides:
remove in class AbstractObjectSet<K>
See Also:
Collection.remove(Object)

add

public boolean add(K k)
Specified by:
add in interface Collection<K>
Specified by:
add in interface Set<K>
Overrides:
add in class AbstractObjectCollection<K>

clear

public void clear()
Specified by:
clear in interface Collection<K>
Specified by:
clear in interface Set<K>
Overrides:
clear in class AbstractObjectCollection<K>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Collection<K>
Specified by:
isEmpty in interface Set<K>
Overrides:
isEmpty in class AbstractObjectCollection<K>

clone

public Object clone()
Returns a deep copy of this set.

This method performs a deep copy of this hash set; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Overrides:
clone in class Object
Returns:
a deep copy of this set.