ObjectArraySet (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.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>, java.util.SortedSet<T>, ObjectCollection<T>, ObjectIterable<T>, ObjectSet<T>, ObjectSortedSet<T>
```
public class ObjectArraySet<T>
extends AbstractObjectSet<T>
implements ObjectSortedSet<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)` Deprecated.
`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)` Deprecated.
`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.
`void`	`clear()`
`java.util.Comparator<T>`	`comparator()` A Type Specific Comparator method
`boolean`	`contains(java.lang.Object e)`
`T`	`first()`
`void`	`forEach(java.util.function.Consumer<? super T> action)`
`ObjectSortedSet<T>`	`headSet(T toElement)`
`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()`
`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
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection<?> c)`
`boolean`	`removeAll(ObjectCollection<T> c)` A Type-Specific implementation of removeAll.
`boolean`	`retainAll(java.util.Collection<?> c)`
`boolean`	`retainAll(ObjectCollection<T> c)` A Type-Specific implementation of retainAll.
`int`	`size()`
`ObjectSortedSet<T>`	`subSet(T fromElement, T toElement)`
`ObjectSortedSet<T>`	`tailSet(T fromElement)`
`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, addAll, containsAll, containsAny, containsAny

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

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

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

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

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

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

- 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
```
@Deprecated
public ObjectArraySet(java.util.Collection<? extends T> c)
```
    Deprecated.
    
    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
```
@Deprecated
public ObjectArraySet(java.util.Set<? extends T> s)
```
    Deprecated.
    
    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>
  - addAndMoveToFirst
```
public boolean addAndMoveToFirst(T o)
```
    Description copied from interface: ObjectSortedSet
    
    A customized add method that allows you to insert into the first index.
    
    Specified by:
    
    addAndMoveToFirst in interface ObjectSortedSet<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: ObjectSortedSet
    
    A customized add method that allows you to insert into the last index.
    
    Specified by:
    
    addAndMoveToLast in interface ObjectSortedSet<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: ObjectSortedSet
    
    A specific move method to move a given key to the first index.
    
    Specified by:
    
    moveToFirst in interface ObjectSortedSet<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: ObjectSortedSet
    
    A specific move method to move a given key to the last index.
    
    Specified by:
    
    moveToLast in interface ObjectSortedSet<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()
```
    Specified by:
    
    first in interface java.util.SortedSet<T>
  - last
```
public T last()
```
    Specified by:
    
    last in interface java.util.SortedSet<T>
  - 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)
  - 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)
  - 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: ObjectSortedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirst in interface ObjectSortedSet<T>
    
    Returns:
    
    first element in the set
  - pollLast
```
public T pollLast()
```
    Description copied from interface: ObjectSortedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLast in interface ObjectSortedSet<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>
  - 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 ObjectSet<T>
    
    Specified by:
    
    iterator in interface ObjectSortedSet<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: ObjectSortedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface ObjectSortedSet<T>
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - subSet
```
public ObjectSortedSet<T> subSet(T fromElement,
                                 T toElement)
```
    Specified by:
    
    subSet in interface java.util.SortedSet<T>
    
    Specified by:
    
    subSet in interface ObjectSortedSet<T>
  - headSet
```
public ObjectSortedSet<T> headSet(T toElement)
```
    Specified by:
    
    headSet in interface java.util.SortedSet<T>
    
    Specified by:
    
    headSet in interface ObjectSortedSet<T>
  - tailSet
```
public ObjectSortedSet<T> tailSet(T fromElement)
```
    Specified by:
    
    tailSet in interface java.util.SortedSet<T>
    
    Specified by:
    
    tailSet in interface ObjectSortedSet<T>
  - comparator
```
public java.util.Comparator<T> comparator()
```
    Description copied from interface: ObjectSortedSet
    
    A Type Specific Comparator method
    
    Specified by:
    
    comparator in interface java.util.SortedSet<T>
    
    Specified by:
    
    comparator in interface ObjectSortedSet<T>
    
    Returns:
    
    the type specific comparator
  - 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.ObjectSortedSet

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

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Constructor Detail

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

ObjectArraySet

Method Detail

add

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

contains

first

last

removeAll

retainAll

removeAll

retainAll

remove

pollFirst

pollLast

forEach

iterator

iterator

subSet

headSet

tailSet

comparator

clear

size

toArray

toArray