ObjectOpenHashSet (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractCollection<T>
- - speiger.src.collections.objects.collections.AbstractObjectCollection<T>
  - - speiger.src.collections.objects.sets.AbstractObjectSet<T>
    - - speiger.src.collections.objects.sets.ObjectOpenHashSet<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>, ObjectCollection<T>, ObjectIterable<T>, ObjectSet<T>, ITrimmable

Direct Known Subclasses:

ObjectLinkedOpenHashSet
```
public class ObjectOpenHashSet<T>
extends AbstractObjectSet<T>
implements ITrimmable
```
A Type Specific Custom implementation of the HashSet Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys. Extra to that there is a couple quality of life functions provided

Constructor Summary

Constructors
Constructor and Description
`ObjectOpenHashSet()` Default Constructor
`ObjectOpenHashSet(java.util.Collection<? extends T> collection)` Deprecated.
`ObjectOpenHashSet(java.util.Collection<? extends T> collection, float loadFactor)` Deprecated.
`ObjectOpenHashSet(int minCapacity)` Constructor that defines the minimum capacity
`ObjectOpenHashSet(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`ObjectOpenHashSet(java.util.Iterator<T> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ObjectOpenHashSet(java.util.Iterator<T> iterator, float loadFactor)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ObjectOpenHashSet(ObjectCollection<T> collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectOpenHashSet(ObjectCollection<T> collection, float loadFactor)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectOpenHashSet(T[] array)` Helper constructor that allow to create a set from unboxed values
`ObjectOpenHashSet(T[] array, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`ObjectOpenHashSet(T[] array, int offset, int length)` Helper constructor that allow to create a set from unboxed values
`ObjectOpenHashSet(T[] array, int offset, int length, float loadFactor)` Helper constructor that allow to create a set from unboxed values

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(T o)`
`boolean`	`addAll(java.util.Collection<? extends T> c)` Deprecated.
`boolean`	`addAll(ObjectCollection<T> c)` A Type-Specific addAll function to reduce (un)boxing
`void`	`clear()`
`void`	`clearAndTrim(int size)` Trims the collection down to the requested size and clears all elements while doing so
`boolean`	`contains(java.lang.Object o)`
`ObjectIterator<T>`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`boolean`	`remove(java.lang.Object o)`
`int`	`size()`
`boolean`	`trim(int size)` Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Methods inherited from class speiger.src.collections.objects.sets.AbstractObjectSet
equals, hashCode

Methods inherited from class speiger.src.collections.objects.collections.AbstractObjectCollection
containsAll, containsAny, containsAny, removeAll, retainAll

Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

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

Methods inherited from interface speiger.src.collections.utils.ITrimmable
clearAndTrim, trim

Methods inherited from interface speiger.src.collections.objects.sets.ObjectSet
spliterator

Methods inherited from interface java.util.Set
containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection
containsAll, containsAny, containsAny, removeAll, retainAll

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - ObjectOpenHashSet
```
public ObjectOpenHashSet()
```
    Default Constructor
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(int minCapacity)
```
    Constructor that defines the minimum capacity
    
    Parameters:
    
    minCapacity - the minimum capacity the HashSet is allowed to be.
    
    Throws:
    
    java.lang.IllegalStateException - if the minimum capacity is negative
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(int minCapacity,
                         float loadFactor)
```
    Constructor that defines the minimum capacity and load factor
    
    Parameters:
    
    minCapacity - the minimum capacity the HashSet is allowed to be.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the minimum capacity is negative
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(T[] array)
```
    Helper constructor that allow to create a set from unboxed values
    
    Parameters:
    
    array - the elements that should be put into the set
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(T[] array,
                         float loadFactor)
```
    Helper constructor that allow to create a set from unboxed values
    
    Parameters:
    
    array - the elements that should be put into the set
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(T[] array,
                         int offset,
                         int length)
```
    Helper constructor that allow to create a set from unboxed values
    
    Parameters:
    
    array - the elements that should be put into the set
    
    offset - the starting index within the array that should be used
    
    length - the amount of elements used from the array
    
    Throws:
    
    java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(T[] array,
                         int offset,
                         int length,
                         float loadFactor)
```
    Helper constructor that allow to create a set from unboxed values
    
    Parameters:
    
    array - the elements that should be put into the set
    
    offset - the starting index within the array that should be used
    
    length - the amount of elements used from the array
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
    
    java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range
  - ObjectOpenHashSet
```
@Deprecated
public ObjectOpenHashSet(java.util.Collection<? extends T> collection)
```
    Deprecated.
    
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the Set
  - ObjectOpenHashSet
```
@Deprecated
public ObjectOpenHashSet(java.util.Collection<? extends T> collection,
                                      float loadFactor)
```
    Deprecated.
    
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the Set
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(ObjectCollection<T> collection)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the Set
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(ObjectCollection<T> collection,
                         float loadFactor)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the Set
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(java.util.Iterator<T> iterator)
```
    A Helper constructor that allows to create a set from a iterator of an unknown size
    
    Parameters:
    
    iterator - the elements that should be added to the set
  - ObjectOpenHashSet
```
public ObjectOpenHashSet(java.util.Iterator<T> iterator,
                         float loadFactor)
```
    A Helper constructor that allows to create a set from a iterator of an unknown size
    
    Parameters:
    
    iterator - the elements that should be added to the set
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
- Method Detail
  - add
```
public boolean add(T o)
```
    Specified by:
    
    add in interface java.util.Collection<T>
    
    Specified by:
    
    add in interface java.util.Set<T>
    
    Overrides:
    
    add in class java.util.AbstractCollection<T>
  - addAll
```
@Deprecated
public boolean addAll(java.util.Collection<? extends T> c)
```
    Deprecated.
    
    Description copied from class: AbstractObjectCollection
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    addAll in interface java.util.Collection<T>
    
    Specified by:
    
    addAll in interface java.util.Set<T>
    
    Overrides:
    
    addAll in class AbstractObjectCollection<T>
  - addAll
```
public boolean addAll(ObjectCollection<T> c)
```
    Description copied from interface: ObjectCollection
    
    A Type-Specific addAll function to reduce (un)boxing
    
    Specified by:
    
    addAll in interface ObjectCollection<T>
    
    Overrides:
    
    addAll in class AbstractObjectCollection<T>
    
    Parameters:
    
    c - the collection of elements that should be added
    
    Returns:
    
    true if elements were added into the collection
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection<T>
    
    Specified by:
    
    contains in interface java.util.Set<T>
    
    Overrides:
    
    contains in class java.util.AbstractCollection<T>
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection<T>
    
    Specified by:
    
    remove in interface java.util.Set<T>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<T>
  - trim
```
public boolean trim(int size)
```
    Description copied from interface: ITrimmable
    
    Trims the original collection down to the size of the current elements or the requested size depending which is bigger
    
    Specified by:
    
    trim in interface ITrimmable
    
    Parameters:
    
    size - the requested trim size.
    
    Returns:
    
    if the internal array has been trimmed.
  - clearAndTrim
```
public void clearAndTrim(int size)
```
    Description copied from interface: ITrimmable
    
    Trims the collection down to the requested size and clears all elements while doing so
    
    Specified by:
    
    clearAndTrim in interface ITrimmable
    
    Parameters:
    
    size - the amount of elements that should be allowed
  - iterator
```
public ObjectIterator<T> iterator()
```
    Description copied from interface: ObjectCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
    
    Specified by:
    
    iterator in interface java.util.Collection<T>
    
    Specified by:
    
    iterator in interface java.util.Set<T>
    
    Specified by:
    
    iterator in interface ObjectCollection<T>
    
    Specified by:
    
    iterator in interface ObjectIterable<T>
    
    Specified by:
    
    iterator in interface ObjectSet<T>
    
    Specified by:
    
    iterator in class AbstractObjectSet<T>
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<T>
    
    Specified by:
    
    clear in interface java.util.Set<T>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<T>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<T>
    
    Specified by:
    
    size in interface java.util.Set<T>
    
    Specified by:
    
    size in class java.util.AbstractCollection<T>

Class ObjectOpenHashSet<T>

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.objects.sets.AbstractObjectSet

Methods inherited from class speiger.src.collections.objects.collections.AbstractObjectCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.utils.ITrimmable

Methods inherited from interface speiger.src.collections.objects.sets.ObjectSet

Methods inherited from interface java.util.Set

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

ObjectOpenHashSet

Method Detail

add

addAll

addAll

contains

remove

trim

clearAndTrim

iterator

clear

size