ObjectArraySet (Primitive-Collections 0.7.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.ObjectArraySet<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>, ObjectOrderedSet<T>, ObjectSet<T>
```
public class ObjectArraySet<T>
extends AbstractObjectSet<T>
implements ObjectOrderedSet<T>
```
A Type Specific ArraySet implementation. That is based around the idea of List.indexOf(Object) for no duplication. Unless a array constructor is used the ArraySet does not allow for duplication. This implementation does not shrink the backing array

Constructor Summary

Constructors
Constructor and Description
`ObjectArraySet()` Default Constructor
`ObjectArraySet(java.util.Collection<? extends T> c)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectArraySet(int capacity)` Minimum Capacity Constructor
`ObjectArraySet(ObjectCollection<T> c)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectArraySet(ObjectSet<T> s)` A Helper constructor that fast copies the element out of a set into the ArraySet.
`ObjectArraySet(java.util.Set<? extends T> s)` A Helper constructor that fast copies the element out of a set into the ArraySet.
`ObjectArraySet(T[] array)` Constructur using initial Array
`ObjectArraySet(T[] array, int length)` Constructur using initial Array

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(T o)`
`boolean`	`addAndMoveToFirst(T o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(T o)` A customized add method that allows you to insert into the last index.
`T`	`addOrGet(T o)` A Helper method that allows to add a element or getting the already present implement.
`void`	`clear()`
`boolean`	`contains(java.lang.Object e)`
`ObjectArraySet<T>`	`copy()` A Function that does a shallow clone of the Collection itself.
`int`	`count(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to count the valid elements.
`T`	`findFirst(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for the first match.
`T`	`first()` A method to get the first element in the set
`void`	`forEach(java.util.function.Consumer<? super T> action)`
`<E> void`	`forEach(E input, ObjectObjectConsumer<E,T> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`ObjectBidirectionalIterator<T>`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`ObjectBidirectionalIterator<T>`	`iterator(T fromElement)` A type Specific Iterator starting from a given key
`T`	`last()` A method to get the last element in the set
`boolean`	`matchesAll(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for no matches.
`boolean`	`moveToFirst(T o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(T o)` A specific move method to move a given key to the last index.
`T`	`pollFirst()` A method to get and remove the first element in the set
`T`	`pollLast()` A method to get and remove the last element in the set
`<E> E`	`reduce(E identity, java.util.function.BiFunction<E,T,E> operator)` Performs a reduction on the elements of this Iterable
`T`	`reduce(ObjectObjectUnaryOperator<T,T> operator)` Performs a reduction on the elements of this Iterable
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection<?> c)`
`boolean`	`removeAll(ObjectCollection<T> c)` A Type-Specific implementation of removeAll.
`boolean`	`removeAll(ObjectCollection<T> c, java.util.function.Consumer<T> r)` A Type-Specific removeAll function that reduces (un)boxing.
`boolean`	`retainAll(java.util.Collection<?> c)`
`boolean`	`retainAll(ObjectCollection<T> c)` A Type-Specific implementation of retainAll.
`boolean`	`retainAll(ObjectCollection<T> c, java.util.function.Consumer<T> r)` A Type-Specific retainAll function that reduces (un)boxing.
`int`	`size()`
`java.lang.Object[]`	`toArray()` Deprecated.
`<E> E[]`	`toArray(E[] a)`

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

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

Methods inherited from class java.util.AbstractCollection
addAll, isEmpty, toString

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

Methods inherited from interface speiger.src.collections.objects.sets.ObjectOrderedSet
spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Set
addAll, containsAll, equals, hashCode, isEmpty

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection
addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, pour, toArray

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

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable
arrayflatMap, asAsync, distinct, filter, flatMap, limit, map, peek, pourAsList, pourAsSet, sorted

- Constructor Detail
  - ObjectArraySet
```
public ObjectArraySet()
```
    Default Constructor
  - ObjectArraySet
```
public ObjectArraySet(int capacity)
```
    Minimum Capacity Constructor
    
    Parameters:
    
    capacity - the minimum capacity of the internal array
    
    Throws:
    
    java.lang.NegativeArraySizeException - if the capacity is negative
  - ObjectArraySet
```
public ObjectArraySet(T[] array)
```
    Constructur using initial Array
    
    Parameters:
    
    array - the array that should be used for set.
  - ObjectArraySet
```
public ObjectArraySet(T[] array,
                      int length)
```
    Constructur using initial Array
    
    Parameters:
    
    array - the array that should be used for set.
    
    length - the amount of elements present within the array
    
    Throws:
    
    java.lang.NegativeArraySizeException - if the length is negative
  - ObjectArraySet
```
public ObjectArraySet(java.util.Collection<? extends T> c)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    c - the elements that should be added to the set.
    
    Note:
    
    this slowly checks every element to remove duplicates
  - ObjectArraySet
```
public ObjectArraySet(ObjectCollection<T> c)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    c - the elements that should be added to the set.
    
    Note:
    
    this slowly checks every element to remove duplicates
  - ObjectArraySet
```
public ObjectArraySet(java.util.Set<? extends T> s)
```
    A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place
    
    Parameters:
    
    s - the set the element should be taken from
  - ObjectArraySet
```
public ObjectArraySet(ObjectSet<T> s)
```
    A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place
    
    Parameters:
    
    s - the set the element should be taken from
- 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>
  - addOrGet
```
public T addOrGet(T o)
```
    Description copied from interface: ObjectSet
    
    A Helper method that allows to add a element or getting the already present implement. Allowing to make unique references reuseable.
    
    Specified by:
    
    addOrGet in interface ObjectSet<T>
    
    Overrides:
    
    addOrGet in class AbstractObjectSet<T>
    
    Parameters:
    
    o - the element to add
    
    Returns:
    
    either the inserted element or the present element.
  - addAndMoveToFirst
```
public boolean addAndMoveToFirst(T o)
```
    Description copied from interface: ObjectOrderedSet
    
    A customized add method that allows you to insert into the first index.
    
    Specified by:
    
    addAndMoveToFirst in interface ObjectOrderedSet<T>
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - addAndMoveToLast
```
public boolean addAndMoveToLast(T o)
```
    Description copied from interface: ObjectOrderedSet
    
    A customized add method that allows you to insert into the last index.
    
    Specified by:
    
    addAndMoveToLast in interface ObjectOrderedSet<T>
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - moveToFirst
```
public boolean moveToFirst(T o)
```
    Description copied from interface: ObjectOrderedSet
    
    A specific move method to move a given key to the first index.
    
    Specified by:
    
    moveToFirst in interface ObjectOrderedSet<T>
    
    Parameters:
    
    o - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(T o)
```
    Description copied from interface: ObjectOrderedSet
    
    A specific move method to move a given key to the last index.
    
    Specified by:
    
    moveToLast in interface ObjectOrderedSet<T>
    
    Parameters:
    
    o - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - contains
```
public boolean contains(java.lang.Object e)
```
    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>
  - first
```
public T first()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get the first element in the set
    
    Specified by:
    
    first in interface ObjectOrderedSet<T>
    
    Returns:
    
    first element in the set
  - last
```
public T last()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get the last element in the set
    
    Specified by:
    
    last in interface ObjectOrderedSet<T>
    
    Returns:
    
    last element in the set
  - removeAll
```
public boolean removeAll(ObjectCollection<T> c)
```
    Description copied from class: AbstractObjectCollection
    
    A Type-Specific implementation of removeAll. This Implementation iterates over all elements and removes them as they were found in the other collection.
    
    Specified by:
    
    removeAll in interface ObjectCollection<T>
    
    Overrides:
    
    removeAll in class AbstractObjectCollection<T>
    
    Parameters:
    
    c - the elements that should be deleted
    
    Returns:
    
    true if the collection was modified.
    
    See Also:
    
    Collection.removeAll(Collection)
  - removeAll
```
public boolean removeAll(ObjectCollection<T> c,
                         java.util.function.Consumer<T> r)
```
    Description copied from interface: ObjectCollection
    
    A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    Specified by:
    
    removeAll in interface ObjectCollection<T>
    
    Overrides:
    
    removeAll in class AbstractObjectCollection<T>
    
    Parameters:
    
    c - the collection of elements that should be removed
    
    r - elements that got removed
    
    Returns:
    
    true if any element was removed
    
    See Also:
    
    Collection.removeAll(Collection)
  - retainAll
```
public boolean retainAll(ObjectCollection<T> c)
```
    Description copied from class: AbstractObjectCollection
    
    A Type-Specific implementation of retainAll. This Implementation iterates over all elements and removes them as they were not found in the other collection.
    
    Specified by:
    
    retainAll in interface ObjectCollection<T>
    
    Overrides:
    
    retainAll in class AbstractObjectCollection<T>
    
    Parameters:
    
    c - the elements that should be kept
    
    Returns:
    
    true if the collection was modified.
    
    See Also:
    
    Collection.retainAll(Collection)
  - retainAll
```
public boolean retainAll(ObjectCollection<T> c,
                         java.util.function.Consumer<T> r)
```
    Description copied from interface: ObjectCollection
    
    A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    Specified by:
    
    retainAll in interface ObjectCollection<T>
    
    Overrides:
    
    retainAll in class AbstractObjectCollection<T>
    
    Parameters:
    
    c - the collection of elements that should be kept
    
    r - elements that got removed
    
    Returns:
    
    true if any element was removed
    
    See Also:
    
    Collection.retainAll(Collection)
  - removeAll
```
public boolean removeAll(java.util.Collection<?> c)
```
    Specified by:
    
    removeAll in interface java.util.Collection<T>
    
    Specified by:
    
    removeAll in interface java.util.Set<T>
    
    Overrides:
    
    removeAll in class java.util.AbstractCollection<T>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> c)
```
    Specified by:
    
    retainAll in interface java.util.Collection<T>
    
    Specified by:
    
    retainAll in interface java.util.Set<T>
    
    Overrides:
    
    retainAll 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>
  - pollFirst
```
public T pollFirst()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirst in interface ObjectOrderedSet<T>
    
    Returns:
    
    first element in the set
  - pollLast
```
public T pollLast()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLast in interface ObjectOrderedSet<T>
    
    Returns:
    
    last element in the set
  - forEach
```
public void forEach(java.util.function.Consumer<? super T> action)
```
    Specified by:
    
    forEach in interface java.lang.Iterable<T>
  - forEach
```
public <E> void forEach(E input,
                        ObjectObjectConsumer<E,T> action)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface ObjectIterable<T>
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
  - matchesAny
```
public boolean matchesAny(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - findFirst
```
public T findFirst(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - reduce
```
public <E> E reduce(E identity,
                    java.util.function.BiFunction<E,T,E> operator)
```
    Description copied from interface: ObjectIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ObjectIterable<T>
    
    Type Parameters:
    
    E - the type of elements maintained by this Collection
    
    Parameters:
    
    identity - the start value
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
public T reduce(ObjectObjectUnaryOperator<T,T> operator)
```
    Description copied from interface: ObjectIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ObjectIterable<T>
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - count
```
public int count(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - iterator
```
public ObjectBidirectionalIterator<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 ObjectOrderedSet<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()
  - iterator
```
public ObjectBidirectionalIterator<T> iterator(T fromElement)
```
    Description copied from interface: ObjectOrderedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface ObjectOrderedSet<T>
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - copy
```
public ObjectArraySet<T> copy()
```
    Description copied from interface: ObjectCollection
    
    A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface ObjectCollection<T>
    
    Specified by:
    
    copy in interface ObjectOrderedSet<T>
    
    Specified by:
    
    copy in interface ObjectSet<T>
    
    Overrides:
    
    copy in class AbstractObjectSet<T>
    
    Returns:
    
    a Shallow Copy of the collection
  - 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>
  - toArray
```
@Deprecated
public java.lang.Object[] toArray()
```
    Deprecated.
    
    Specified by:
    
    toArray in interface java.util.Collection<T>
    
    Specified by:
    
    toArray in interface java.util.Set<T>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<T>
  - toArray
```
public <E> E[] toArray(E[] a)
```
    Specified by:
    
    toArray in interface java.util.Collection<T>
    
    Specified by:
    
    toArray in interface java.util.Set<T>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<T>

Class ObjectArraySet<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.objects.sets.ObjectOrderedSet

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 speiger.src.collections.objects.collections.ObjectIterable

Constructor Detail

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

Method Detail

add

addOrGet

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

contains

first

last

removeAll

removeAll

retainAll

retainAll

removeAll

retainAll

remove

pollFirst

pollLast

forEach

forEach

matchesAny

matchesNone

matchesAll

findFirst

reduce

reduce

count

iterator

iterator

copy

clear

size

toArray

toArray