ObjectSortedSet (Primitive-Collections 0.2.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

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

All Known Subinterfaces:

Byte2BooleanSortedMap.FastSortedSet, Byte2ByteSortedMap.FastSortedSet, Byte2CharSortedMap.FastSortedSet, Byte2DoubleSortedMap.FastSortedSet, Byte2FloatSortedMap.FastSortedSet, Byte2IntSortedMap.FastSortedSet, Byte2LongSortedMap.FastSortedSet, Byte2ObjectSortedMap.FastSortedSet<V>, Byte2ShortSortedMap.FastSortedSet, Char2BooleanSortedMap.FastSortedSet, Char2ByteSortedMap.FastSortedSet, Char2CharSortedMap.FastSortedSet, Char2DoubleSortedMap.FastSortedSet, Char2FloatSortedMap.FastSortedSet, Char2IntSortedMap.FastSortedSet, Char2LongSortedMap.FastSortedSet, Char2ObjectSortedMap.FastSortedSet<V>, Char2ShortSortedMap.FastSortedSet, Double2BooleanSortedMap.FastSortedSet, Double2ByteSortedMap.FastSortedSet, Double2CharSortedMap.FastSortedSet, Double2DoubleSortedMap.FastSortedSet, Double2FloatSortedMap.FastSortedSet, Double2IntSortedMap.FastSortedSet, Double2LongSortedMap.FastSortedSet, Double2ObjectSortedMap.FastSortedSet<V>, Double2ShortSortedMap.FastSortedSet, Float2BooleanSortedMap.FastSortedSet, Float2ByteSortedMap.FastSortedSet, Float2CharSortedMap.FastSortedSet, Float2DoubleSortedMap.FastSortedSet, Float2FloatSortedMap.FastSortedSet, Float2IntSortedMap.FastSortedSet, Float2LongSortedMap.FastSortedSet, Float2ObjectSortedMap.FastSortedSet<V>, Float2ShortSortedMap.FastSortedSet, Int2BooleanSortedMap.FastSortedSet, Int2ByteSortedMap.FastSortedSet, Int2CharSortedMap.FastSortedSet, Int2DoubleSortedMap.FastSortedSet, Int2FloatSortedMap.FastSortedSet, Int2IntSortedMap.FastSortedSet, Int2LongSortedMap.FastSortedSet, Int2ObjectSortedMap.FastSortedSet<V>, Int2ShortSortedMap.FastSortedSet, Long2BooleanSortedMap.FastSortedSet, Long2ByteSortedMap.FastSortedSet, Long2CharSortedMap.FastSortedSet, Long2DoubleSortedMap.FastSortedSet, Long2FloatSortedMap.FastSortedSet, Long2IntSortedMap.FastSortedSet, Long2LongSortedMap.FastSortedSet, Long2ObjectSortedMap.FastSortedSet<V>, Long2ShortSortedMap.FastSortedSet, Object2BooleanSortedMap.FastSortedSet<T>, Object2ByteSortedMap.FastSortedSet<T>, Object2CharSortedMap.FastSortedSet<T>, Object2DoubleSortedMap.FastSortedSet<T>, Object2FloatSortedMap.FastSortedSet<T>, Object2IntSortedMap.FastSortedSet<T>, Object2LongSortedMap.FastSortedSet<T>, Object2ObjectSortedMap.FastSortedSet<T,V>, Object2ShortSortedMap.FastSortedSet<T>, ObjectNavigableSet<T>, Short2BooleanSortedMap.FastSortedSet, Short2ByteSortedMap.FastSortedSet, Short2CharSortedMap.FastSortedSet, Short2DoubleSortedMap.FastSortedSet, Short2FloatSortedMap.FastSortedSet, Short2IntSortedMap.FastSortedSet, Short2LongSortedMap.FastSortedSet, Short2ObjectSortedMap.FastSortedSet<V>, Short2ShortSortedMap.FastSortedSet

All Known Implementing Classes:

ObjectArraySet, ObjectAVLTreeSet, ObjectLinkedOpenCustomHashSet, ObjectLinkedOpenHashSet, ObjectRBTreeSet
```
public interface ObjectSortedSet<T>
extends ObjectSet<T>, java.util.SortedSet<T>
```
A Type Specific SortedSet implementation to reduce boxing/unboxing with a couple extra methods that allow greater control over sets.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`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.
`java.util.Comparator<T>`	`comparator()` A Type Specific Comparator method
`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
`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
`default ObjectSplititerator<T>`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`ObjectSortedSet<T>`	`subSet(T fromElement, T toElement)`
`ObjectSortedSet<T>`	`tailSet(T fromElement)`

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

Methods inherited from interface java.util.SortedSet
first, last

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

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

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - addAndMoveToFirst
```
boolean addAndMoveToFirst(T o)
```
    A customized add method that allows you to insert into the first index.
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
    
    Note:
    
    some implementations do not support this method
  - addAndMoveToLast
```
boolean addAndMoveToLast(T o)
```
    A customized add method that allows you to insert into the last index.
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
    
    Note:
    
    some implementations do not support this method
  - moveToFirst
```
boolean moveToFirst(T o)
```
    A specific move method to move a given key to the first index.
    
    Parameters:
    
    o - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
    
    Note:
    
    returns false if the value was not present in the first place, some implementations do not support this method
  - moveToLast
```
boolean moveToLast(T o)
```
    A specific move method to move a given key to the last index.
    
    Parameters:
    
    o - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
    
    Note:
    
    returns false if the value was not present in the first place, some implementations do not support this method
  - comparator
```
java.util.Comparator<T> comparator()
```
    A Type Specific Comparator method
    
    Specified by:
    
    comparator in interface java.util.SortedSet<T>
    
    Returns:
    
    the type specific comparator
  - iterator
```
ObjectBidirectionalIterator<T> iterator()
```
    Description copied from interface: ObjectCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface java.util.Collection<T>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<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 java.util.Set<T>
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
ObjectBidirectionalIterator<T> iterator(T fromElement)
```
    A type Specific Iterator starting from a given key
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
    
    Throws:
    
    java.util.NoSuchElementException - if fromElement isn't found
  - spliterator
```
default ObjectSplititerator<T> spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface java.util.Collection<T>
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<T>
    
    Specified by:
    
    spliterator in interface ObjectCollection<T>
    
    Specified by:
    
    spliterator in interface ObjectIterable<T>
    
    Specified by:
    
    spliterator in interface ObjectSet<T>
    
    Specified by:
    
    spliterator in interface java.util.Set<T>
    
    Specified by:
    
    spliterator in interface java.util.SortedSet<T>
    
    Returns:
    
    type specific splititerator
  - pollFirst
```
T pollFirst()
```
    A method to get and remove the first element in the set
    
    Returns:
    
    first element in the set
  - pollLast
```
T pollLast()
```
    A method to get and remove the last element in the set
    
    Returns:
    
    last element in the set
  - subSet
```
ObjectSortedSet<T> subSet(T fromElement,
                          T toElement)
```
    Specified by:
    
    subSet in interface java.util.SortedSet<T>
  - headSet
```
ObjectSortedSet<T> headSet(T toElement)
```
    Specified by:
    
    headSet in interface java.util.SortedSet<T>
  - tailSet
```
ObjectSortedSet<T> tailSet(T fromElement)
```
    Specified by:
    
    tailSet in interface java.util.SortedSet<T>

Interface ObjectSortedSet<T>

Method Summary

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

Methods inherited from interface java.util.SortedSet

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

comparator

iterator

iterator

spliterator

pollFirst

pollLast

subSet

headSet

tailSet