FastSet (Javolution 5.5.1 API)

java.lang.Object
- _templates.javolution.util.FastCollection
- - _templates.javolution.util.FastSet

All Implemented Interfaces:

Serializable, Iterable, Collection, Set, Realtime, Reusable, XMLSerializable

Direct Known Subclasses:

HashSet, LinkedHashSet
```
public class FastSet
extends FastCollection
implements Set, Reusable
```
This class represents a set collection backed by a FastMap; smooth capacity increase and no rehashing ever performed.

FastSet, as for any FastCollection sub-class, supports thread-safe fast iterations without using iterators. For example:[code] for (FastSet.Record r = set.head(), end = set.tail(); (r = r.getNext()) != end;) { Object value = set.valueOf(r); }[/code]

Version:

4.2, December 18, 2006

Author:

Jean-Marie Dautelle

Nested Class Summary
- Nested classes/interfaces inherited from class _templates.javolution.util.FastCollection
  FastCollection.Record

Constructor Summary

Constructors
Constructor and Description
`FastSet()` Creates a set of small initial capacity.
`FastSet(int capacity)` Creates a set of specified initial capacity; unless the set size reaches the specified capacity, operations on this set will not allocate memory (no lazy object creation).
`FastSet(Set elements)` Creates a set containing the specified elements, in the order they are returned by the set iterator.
`FastSet(String id)` Creates a persistent set associated to the specified unique identifier (convenience method).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Object value)` Adds the specified value to this set if it is not already present.
`void`	`clear()` Removes all of the values from this collection (optional operation).
`boolean`	`contains(Object o)` Indicates if this collection contains the specified value.
`void`	`delete(FastCollection.Record record)` Deletes the specified record from this collection.
`FastComparator`	`getValueComparator()` Returns the value comparator for this collection (default `FastComparator.DEFAULT`).
`FastCollection.Record`	`head()` Returns the head record of this collection; it is the record such as `head().getNext()` holds the first collection value.
`Iterator`	`iterator()` Returns an iterator over the elements in this set (allocated on the stack when executed in a `StackContext`).
`static FastSet`	`newInstance()` Returns a new, preallocated or `recycled` set instance (on the stack when executing in a `StackContext`).
`static void`	`recycle(FastSet instance)` Recycles a set `instance` immediately (on the stack when executing in a `StackContext`).
`boolean`	`remove(Object o)` Removes the first occurrence in this collection of the specified value (optional operation).
`void`	`reset()` Resets the internal state of this object to its default values.
`FastSet`	`setValueComparator(FastComparator comparator)` Sets the comparator to use for value equality.
`int`	`size()` Returns the number of elements in this set (its cardinality).
`FastCollection.Record`	`tail()` Returns the tail record of this collection; it is the record such as `tail().getPrevious()` holds the last collection value.
`Collection`	`unmodifiable()` Returns the unmodifiable view associated to this collection.
`Object`	`valueOf(FastCollection.Record record)` Returns the collection value for the specified record.

Methods inherited from class _templates.javolution.util.FastCollection
addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, shared, toArray, toArray, toString, toText

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

Methods inherited from interface _templates.java.util.Set
addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

- Constructor Detail
  - FastSet
```
public FastSet()
```
    Creates a set of small initial capacity.
  - FastSet
```
public FastSet(String id)
```
    Creates a persistent set associated to the specified unique identifier (convenience method).
    
    Parameters:
    
    id - the unique identifier for this map.
    
    Throws:
    
    IllegalArgumentException - if the identifier is not unique.
    
    See Also:
    
    PersistentContext.Reference
  - FastSet
```
public FastSet(int capacity)
```
    Creates a set of specified initial capacity; unless the set size reaches the specified capacity, operations on this set will not allocate memory (no lazy object creation).
    
    Parameters:
    
    capacity - the initial capacity.
  - FastSet
```
public FastSet(Set elements)
```
    Creates a set containing the specified elements, in the order they are returned by the set iterator.
    
    Parameters:
    
    elements - the elements to be placed into this fast set.
- Method Detail
  - newInstance
```
public static FastSet newInstance()
```
    Returns a new, preallocated or recycled set instance (on the stack when executing in a StackContext).
    
    Returns:
    
    a new, preallocated or recycled set instance.
  - recycle
```
public static void recycle(FastSet instance)
```
    Recycles a set instance immediately (on the stack when executing in a StackContext).
  - size
```
public final int size()
```
    Returns the number of elements in this set (its cardinality).
    
    Specified by:
    
    size in interface Collection
    
    Specified by:
    
    size in interface Set
    
    Specified by:
    
    size in class FastCollection
    
    Returns:
    
    the number of elements in this set (its cardinality).
  - add
```
public final boolean add(Object value)
```
    Adds the specified value to this set if it is not already present.
    
    Specified by:
    
    add in interface Collection
    
    Specified by:
    
    add in interface Set
    
    Overrides:
    
    add in class FastCollection
    
    Parameters:
    
    value - the value to be added to this set.
    
    Returns:
    
    true if this set did not already contain the specified element.
    
    Throws:
    
    NullPointerException - if the value is null.
  - iterator
```
public Iterator iterator()
```
    Returns an iterator over the elements in this set (allocated on the stack when executed in a StackContext).
    
    Specified by:
    
    iterator in interface Iterable
    
    Specified by:
    
    iterator in interface Collection
    
    Specified by:
    
    iterator in interface Set
    
    Overrides:
    
    iterator in class FastCollection
    
    Returns:
    
    an iterator over this set values.
  - unmodifiable
```
public Collection unmodifiable()
```
    Description copied from class: FastCollection
    
    Returns the unmodifiable view associated to this collection. Attempts to modify the returned collection result in an UnsupportedOperationException being thrown.
    
    Overrides:
    
    unmodifiable in class FastCollection
    
    Returns:
    
    the unmodifiable view over this collection.
  - clear
```
public final void clear()
```
    Description copied from class: FastCollection
    
    Removes all of the values from this collection (optional operation).
    
    Specified by:
    
    clear in interface Collection
    
    Specified by:
    
    clear in interface Set
    
    Overrides:
    
    clear in class FastCollection
  - contains
```
public final boolean contains(Object o)
```
    Description copied from class: FastCollection
    
    Indicates if this collection contains the specified value.
    
    Specified by:
    
    contains in interface Collection
    
    Specified by:
    
    contains in interface Set
    
    Overrides:
    
    contains in class FastCollection
    
    Parameters:
    
    o - the value whose presence in this collection is to be tested.
    
    Returns:
    
    true if this collection contains the specified value;false otherwise.
  - remove
```
public final boolean remove(Object o)
```
    Description copied from class: FastCollection
    
    Removes the first occurrence in this collection of the specified value (optional operation).
    
    Specified by:
    
    remove in interface Collection
    
    Specified by:
    
    remove in interface Set
    
    Overrides:
    
    remove in class FastCollection
    
    Parameters:
    
    o - the value to be removed from this collection.
    
    Returns:
    
    true if this collection contained the specified value; false otherwise.
  - setValueComparator
```
public FastSet setValueComparator(FastComparator comparator)
```
    Sets the comparator to use for value equality.
    
    Parameters:
    
    comparator - the value comparator.
    
    Returns:
    
    this
  - getValueComparator
```
public FastComparator getValueComparator()
```
    Description copied from class: FastCollection
    
    Returns the value comparator for this collection (default FastComparator.DEFAULT).
    
    Overrides:
    
    getValueComparator in class FastCollection
    
    Returns:
    
    the comparator to use for value equality (or ordering if the collection is ordered)
  - reset
```
public void reset()
```
    Description copied from interface: Reusable
    
    Resets the internal state of this object to its default values.
    
    Specified by:
    
    reset in interface Reusable
  - head
```
public final FastCollection.Record head()
```
    Description copied from class: FastCollection
    
    Returns the head record of this collection; it is the record such as head().getNext() holds the first collection value.
    
    Specified by:
    
    head in class FastCollection
    
    Returns:
    
    the head record.
  - tail
```
public final FastCollection.Record tail()
```
    Description copied from class: FastCollection
    
    Returns the tail record of this collection; it is the record such as tail().getPrevious() holds the last collection value.
    
    Specified by:
    
    tail in class FastCollection
    
    Returns:
    
    the tail record.
  - valueOf
```
public final Object valueOf(FastCollection.Record record)
```
    Description copied from class: FastCollection
    
    Returns the collection value for the specified record.
    
    Specified by:
    
    valueOf in class FastCollection
    
    Parameters:
    
    record - the record whose current value is returned.
    
    Returns:
    
    the current value.
  - delete
```
public final void delete(FastCollection.Record record)
```
    Description copied from class: FastCollection
    
    Deletes the specified record from this collection.
    Implementation must ensure that removing a record from the collection does not affect in any way the records preceding the record being removed (it might affect the next records though, e.g. in a list collection, the indices of the subsequent records will change).
    
    Specified by:
    
    delete in class FastCollection
    
    Parameters:
    
    record - the record to be removed.

Class FastSet

Nested Class Summary

Nested classes/interfaces inherited from class _templates.javolution.util.FastCollection

Constructor Summary

Method Summary

Methods inherited from class _templates.javolution.util.FastCollection

Methods inherited from class java.lang.Object

Methods inherited from interface _templates.java.util.Set

Constructor Detail

FastSet

FastSet

FastSet

FastSet

Method Detail

newInstance

recycle

size

add

iterator

unmodifiable

clear

contains

remove

setValueComparator

getValueComparator

reset

head

tail

valueOf

delete