CharOrderedSet (Primitive-Collections 0.7.0 API)

All Superinterfaces:

CharCollection, CharIterable, CharSet, java.util.Collection<java.lang.Character>, java.lang.Iterable<java.lang.Character>, java.util.Set<java.lang.Character>

All Known Implementing Classes:

CharArraySet, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, ImmutableCharOpenHashSet
```
public interface CharOrderedSet
extends CharSet
```
A Special Set Interface giving Access to some really usefull functions The Idea behind this interface is to allow access to functions that give control to the Order of elements. Since Linked implementations as examples can be reordered outside of the Insertion Order. This interface provides basic access to such functions while also providing some Sorted/NaivgableSet implementations that still fit into here.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`addAndMoveToFirst(char o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(char o)` A customized add method that allows you to insert into the last index.
`CharOrderedSet`	`copy()` A Function that does a shallow clone of the Collection itself.
`char`	`firstChar()` A method to get the first element in the set
`CharBidirectionalIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`CharBidirectionalIterator`	`iterator(char fromElement)` A type Specific Iterator starting from a given key
`char`	`lastChar()` A method to get the last element in the set
`boolean`	`moveToFirst(char o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(char o)` A specific move method to move a given key to the last index.
`char`	`pollFirstChar()` A method to get and remove the first element in the set
`char`	`pollLastChar()` A method to get and remove the last element in the set
`default CharSplititerator`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`default CharOrderedSet`	`synchronize()` Creates a Wrapped OrderedSet that is Synchronized
`default CharOrderedSet`	`synchronize(java.lang.Object mutex)` Creates a Wrapped OrderedSet that is Synchronized
`default CharOrderedSet`	`unmodifiable()` Creates a Wrapped OrderedSet that is unmodifiable

Methods inherited from interface speiger.src.collections.chars.sets.CharSet
add, contains, remChar, remove, remove

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

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection
add, addAll, addAll, addAll, addAll, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toCharArray, toCharArray

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

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable
arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

- Method Detail
  - addAndMoveToFirst
```
boolean addAndMoveToFirst(char 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)
  - addAndMoveToLast
```
boolean addAndMoveToLast(char 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)
  - moveToFirst
```
boolean moveToFirst(char 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
  - moveToLast
```
boolean moveToLast(char 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
  - copy
```
CharOrderedSet copy()
```
    Description copied from interface: CharCollection
    
    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 CharCollection
    
    Specified by:
    
    copy in interface CharSet
    
    Returns:
    
    a Shallow Copy of the collection
  - iterator
```
CharBidirectionalIterator iterator()
```
    Description copied from interface: CharCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface CharCollection
    
    Specified by:
    
    iterator in interface CharIterable
    
    Specified by:
    
    iterator in interface CharSet
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Character>
    
    Specified by:
    
    iterator in interface java.util.Set<java.lang.Character>
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
CharBidirectionalIterator iterator(char 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 CharSplititerator spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface CharCollection
    
    Specified by:
    
    spliterator in interface CharIterable
    
    Specified by:
    
    spliterator in interface CharSet
    
    Specified by:
    
    spliterator in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Character>
    
    Specified by:
    
    spliterator in interface java.util.Set<java.lang.Character>
    
    Returns:
    
    type specific splititerator
  - firstChar
```
char firstChar()
```
    A method to get the first element in the set
    
    Returns:
    
    first element in the set
  - pollFirstChar
```
char pollFirstChar()
```
    A method to get and remove the first element in the set
    
    Returns:
    
    first element in the set
  - lastChar
```
char lastChar()
```
    A method to get the last element in the set
    
    Returns:
    
    last element in the set
  - pollLastChar
```
char pollLastChar()
```
    A method to get and remove the last element in the set
    
    Returns:
    
    last element in the set
  - synchronize
```
default CharOrderedSet synchronize()
```
    Creates a Wrapped OrderedSet that is Synchronized
    
    Specified by:
    
    synchronize in interface CharCollection
    
    Specified by:
    
    synchronize in interface CharSet
    
    Returns:
    
    a new OrderedSet that is synchronized
    
    See Also:
    
    CharSets.synchronize(speiger.src.collections.chars.sets.CharSet)
  - synchronize
```
default CharOrderedSet synchronize(java.lang.Object mutex)
```
    Creates a Wrapped OrderedSet that is Synchronized
    
    Specified by:
    
    synchronize in interface CharCollection
    
    Specified by:
    
    synchronize in interface CharSet
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new OrderedSet Wrapper that is synchronized
    
    See Also:
    
    CharSets.synchronize(speiger.src.collections.chars.sets.CharSet)
  - unmodifiable
```
default CharOrderedSet unmodifiable()
```
    Creates a Wrapped OrderedSet that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface CharCollection
    
    Specified by:
    
    unmodifiable in interface CharSet
    
    Returns:
    
    a new OrderedSet Wrapper that is unmodifiable
    
    See Also:
    
    CharSets.unmodifiable(speiger.src.collections.chars.sets.CharSet)

Interface CharOrderedSet

Method Summary

Methods inherited from interface speiger.src.collections.chars.sets.CharSet

Methods inherited from interface java.util.Set

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection

Methods inherited from interface java.util.Collection

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

Method Detail

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

copy

iterator

iterator

spliterator

firstChar

pollFirstChar

lastChar

pollLastChar

synchronize

synchronize

unmodifiable