DefaultImmutableSet (KeY API Documentation)

java.lang.Object
- org.key_project.util.collection.DefaultImmutableSet<T>

All Implemented Interfaces:

Serializable, Iterable<T>, ImmutableSet<T>

Direct Known Subclasses:

DefaultImmutableSet.NILSet
```
public class DefaultImmutableSet<T>
extends Object
implements ImmutableSet<T>
```
implementation of a persistent set using the SLListOf implementation with all its implications (means e.g. O(n) for adding an element and so on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class DefaultImmutableSet.NILSet<T>
represents the empty set for elements of type

Nested Classes
Modifier and Type	Class and Description
`private static class`	`DefaultImmutableSet.NILSet<T>` represents the empty set for elements of type

Field Summary

Fields
Modifier and Type	Field and Description
`private ImmutableList<T>`	`elementList` list containing the elements
`private static long`	`serialVersionUID`
`static int`	`UNION_OPTIMIZATION_SIZE` Constant defining the set size at which an optimized union operation will be executed.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DefaultImmutableSet()`
`private`	`DefaultImmutableSet(ImmutableList<T> elementList)` creates new set containg all elements from the elementList PRECONDITION: elementList has no duplicates
`protected`	`DefaultImmutableSet(T element)` creates new set with one element

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImmutableSet<T>`	`add(T element)` adds an element
`ImmutableSet<T>`	`addUnique(T element)` adds an element, barfs if the element is already present
`private void`	`complainAboutSize()`
`boolean`	`contains(T obj)`
`boolean`	`equals(Object obj)`
`static <T> ImmutableSet<T>`	`fromImmutableList(ImmutableList<T> list)` Create an immutable set from an immutable list.
`int`	`hashCode()`
`ImmutableSet<T>`	`intersect(ImmutableSet<T> set)`
`boolean`	`isEmpty()`
`Iterator<T>`	`iterator()`
`private DefaultImmutableSet<T>`	`newUnion(DefaultImmutableSet<T> set)`
`static <T> DefaultImmutableSet<T>`	`nil()` the empty set
`private DefaultImmutableSet<T>`	`originalUnion(ImmutableSet<T> set)`
`ImmutableSet<T>`	`remove(T element)`
`int`	`size()`
`boolean`	`subset(ImmutableSet<T> s)`
`<S> S[]`	`toArray(S[] array)` Convert the set to a Java array (O(n))
`ImmutableList<T>`	`toImmutableList()` Get the underlying immutable list.
`String`	`toString()`
`ImmutableSet<T>`	`union(ImmutableSet<T> set)`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - UNION_OPTIMIZATION_SIZE
```
public static final int UNION_OPTIMIZATION_SIZE
```
    Constant defining the set size at which an optimized union operation will be executed.
    
    See Also:
    
    Constant Field Values
  - elementList
```
private final ImmutableList<T> elementList
```
    list containing the elements
- Constructor Detail
  - DefaultImmutableSet
```
protected DefaultImmutableSet()
```
  - DefaultImmutableSet
```
protected DefaultImmutableSet(T element)
```
    creates new set with one element
    
    Parameters:
    
    element - of type the new Set contains
  - DefaultImmutableSet
```
private DefaultImmutableSet(ImmutableList<T> elementList)
```
    creates new set containg all elements from the elementList PRECONDITION: elementList has no duplicates
    
    Parameters:
    
    elementList - IList contains all elements of the new Set
- Method Detail
  - nil
```
public static final <T> DefaultImmutableSet<T> nil()
```
    the empty set
  - complainAboutSize
```
private void complainAboutSize()
```
  - add
```
public ImmutableSet<T> add(T element)
```
    adds an element
    
    Specified by:
    
    add in interface ImmutableSet<T>
    
    Parameters:
    
    element - of type that has to be added to this set
  - addUnique
```
public ImmutableSet<T> addUnique(T element)
                          throws NotUniqueException
```
    adds an element, barfs if the element is already present
    
    Specified by:
    
    addUnique in interface ImmutableSet<T>
    
    Parameters:
    
    element - of type that has to be added to this set
    
    Throws:
    
    org.key_project.utils.collection.NotUniqueException - if the element is already present
    
    NotUniqueException
  - union
```
public ImmutableSet<T> union(ImmutableSet<T> set)
```
    Specified by:
    
    union in interface ImmutableSet<T>
    
    Returns:
    
    union of this set with set
  - newUnion
```
private DefaultImmutableSet<T> newUnion(DefaultImmutableSet<T> set)
```
  - originalUnion
```
private DefaultImmutableSet<T> originalUnion(ImmutableSet<T> set)
```
  - intersect
```
public ImmutableSet<T> intersect(ImmutableSet<T> set)
```
    Specified by:
    
    intersect in interface ImmutableSet<T>
    
    Returns:
    
    intersection of this set with set
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface ImmutableSet<T>
    
    Returns:
    
    Iterator of the set
  - contains
```
public boolean contains(T obj)
```
    Specified by:
    
    contains in interface ImmutableSet<T>
    
    Returns:
    
    true iff obj in set
  - subset
```
public boolean subset(ImmutableSet<T> s)
```
    Specified by:
    
    subset in interface ImmutableSet<T>
    
    Returns:
    
    true iff this set is subset of set s
  - size
```
public int size()
```
    Specified by:
    
    size in interface ImmutableSet<T>
    
    Returns:
    
    int the cardinality of the set
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface ImmutableSet<T>
    
    Returns:
    
    true iff the set is empty
  - remove
```
public ImmutableSet<T> remove(T element)
```
    Specified by:
    
    remove in interface ImmutableSet<T>
    
    Returns:
    
    set without element
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface ImmutableSet<T>
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true iff the this set is subset of o and vice versa.
  - toArray
```
public <S> S[] toArray(S[] array)
```
    Convert the set to a Java array (O(n))
    
    Specified by:
    
    toArray in interface ImmutableSet<T>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface ImmutableSet<T>
    
    Overrides:
    
    hashCode in class Object
  - toImmutableList
```
public ImmutableList<T> toImmutableList()
```
    Get the underlying immutable list.
    
    Returns:
    
    an immutable list with the same iteration order as this set.
  - fromImmutableList
```
public static <T> ImmutableSet<T> fromImmutableList(ImmutableList<T> list)
```
    Create an immutable set from an immutable list.
    
    Parameters:
    
    list - a non-null immutable list
    
    Returns:
    
    a fresh immutable set with the same iteration order.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DefaultImmutableSet<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

serialVersionUID

UNION_OPTIMIZATION_SIZE

elementList

Constructor Detail

DefaultImmutableSet

DefaultImmutableSet

DefaultImmutableSet

Method Detail

nil

complainAboutSize

add

addUnique

union

newUnion

originalUnion

intersect

iterator

contains

subset

size

isEmpty

remove

equals

toArray

hashCode

toImmutableList

fromImmutableList

toString