Int2ShortMaps.UnmodifyableOrderedEntrySet (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.objects.utils.ObjectCollections.UnmodifiableCollection<T>
- - speiger.src.collections.objects.utils.ObjectSets.UnmodifiableSet<Int2ShortMap.Entry>
  - - speiger.src.collections.ints.utils.maps.Int2ShortMaps.UnmodifyableEntrySet
    - - speiger.src.collections.ints.utils.maps.Int2ShortMaps.UnmodifyableOrderedEntrySet

All Implemented Interfaces:

java.lang.Iterable<Int2ShortMap.Entry>, java.util.Collection<Int2ShortMap.Entry>, java.util.Set<Int2ShortMap.Entry>, ObjectCollection<Int2ShortMap.Entry>, ObjectIterable<Int2ShortMap.Entry>, ObjectOrderedSet<Int2ShortMap.Entry>, ObjectSet<Int2ShortMap.Entry>

Enclosing class:

Int2ShortMaps
```
public static class Int2ShortMaps.UnmodifyableOrderedEntrySet
extends Int2ShortMaps.UnmodifyableEntrySet
implements ObjectOrderedSet<Int2ShortMap.Entry>
```
The Unmodifyable Ordered Set implementation for the Unmodifyable Ordered Map implementation

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAndMoveToFirst(Int2ShortMap.Entry o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(Int2ShortMap.Entry o)` A customized add method that allows you to insert into the last index.
`ObjectOrderedSet<Int2ShortMap.Entry>`	`copy()` A Function that does a shallow clone of the Collection itself.
`Int2ShortMap.Entry`	`first()` A method to get the first element in the set
`ObjectBidirectionalIterator<Int2ShortMap.Entry>`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`ObjectBidirectionalIterator<Int2ShortMap.Entry>`	`iterator(Int2ShortMap.Entry fromElement)` A type Specific Iterator starting from a given key
`Int2ShortMap.Entry`	`last()` A method to get the last element in the set
`boolean`	`moveToFirst(Int2ShortMap.Entry o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(Int2ShortMap.Entry o)` A specific move method to move a given key to the last index.
`Int2ShortMap.Entry`	`pollFirst()` A method to get and remove the first element in the set
`Int2ShortMap.Entry`	`pollLast()` A method to get and remove the last element in the set

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2ShortMaps.UnmodifyableEntrySet
forEach

Methods inherited from class speiger.src.collections.objects.utils.ObjectSets.UnmodifiableSet
addOrGet

Methods inherited from class speiger.src.collections.objects.utils.ObjectCollections.UnmodifiableCollection
add, addAll, addAll, addAll, clear, contains, containsAll, containsAll, containsAny, containsAny, count, equals, findFirst, forEach, hashCode, isEmpty, matchesAll, matchesAny, matchesNone, reduce, reduce, remove, removeAll, removeAll, removeAll, removeIf, retainAll, retainAll, retainAll, size, toArray, toArray, 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 speiger.src.collections.objects.sets.ObjectSet
addOrGet

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 speiger.src.collections.objects.collections.ObjectCollection
addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, pour, removeAll, removeAll, retainAll, retainAll, toArray

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

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

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - addAndMoveToFirst
```
public boolean addAndMoveToFirst(Int2ShortMap.Entry 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<Int2ShortMap.Entry>
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - addAndMoveToLast
```
public boolean addAndMoveToLast(Int2ShortMap.Entry 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<Int2ShortMap.Entry>
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - moveToFirst
```
public boolean moveToFirst(Int2ShortMap.Entry 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<Int2ShortMap.Entry>
    
    Parameters:
    
    o - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(Int2ShortMap.Entry 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<Int2ShortMap.Entry>
    
    Parameters:
    
    o - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - copy
```
public ObjectOrderedSet<Int2ShortMap.Entry> 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<Int2ShortMap.Entry>
    
    Specified by:
    
    copy in interface ObjectOrderedSet<Int2ShortMap.Entry>
    
    Specified by:
    
    copy in interface ObjectSet<Int2ShortMap.Entry>
    
    Overrides:
    
    copy in class ObjectSets.UnmodifiableSet<Int2ShortMap.Entry>
    
    Returns:
    
    a Shallow Copy of the collection
  - iterator
```
public ObjectBidirectionalIterator<Int2ShortMap.Entry> iterator()
```
    Description copied from interface: ObjectCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Int2ShortMap.Entry>
    
    Specified by:
    
    iterator in interface java.util.Collection<Int2ShortMap.Entry>
    
    Specified by:
    
    iterator in interface java.util.Set<Int2ShortMap.Entry>
    
    Specified by:
    
    iterator in interface ObjectCollection<Int2ShortMap.Entry>
    
    Specified by:
    
    iterator in interface ObjectIterable<Int2ShortMap.Entry>
    
    Specified by:
    
    iterator in interface ObjectOrderedSet<Int2ShortMap.Entry>
    
    Specified by:
    
    iterator in interface ObjectSet<Int2ShortMap.Entry>
    
    Overrides:
    
    iterator in class Int2ShortMaps.UnmodifyableEntrySet
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
public ObjectBidirectionalIterator<Int2ShortMap.Entry> iterator(Int2ShortMap.Entry fromElement)
```
    Description copied from interface: ObjectOrderedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface ObjectOrderedSet<Int2ShortMap.Entry>
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - first
```
public Int2ShortMap.Entry first()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get the first element in the set
    
    Specified by:
    
    first in interface ObjectOrderedSet<Int2ShortMap.Entry>
    
    Returns:
    
    first element in the set
  - pollFirst
```
public Int2ShortMap.Entry pollFirst()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirst in interface ObjectOrderedSet<Int2ShortMap.Entry>
    
    Returns:
    
    first element in the set
  - last
```
public Int2ShortMap.Entry last()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get the last element in the set
    
    Specified by:
    
    last in interface ObjectOrderedSet<Int2ShortMap.Entry>
    
    Returns:
    
    last element in the set
  - pollLast
```
public Int2ShortMap.Entry pollLast()
```
    Description copied from interface: ObjectOrderedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLast in interface ObjectOrderedSet<Int2ShortMap.Entry>
    
    Returns:
    
    last element in the set

Class Int2ShortMaps.UnmodifyableOrderedEntrySet

Method Summary

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2ShortMaps.UnmodifyableEntrySet

Methods inherited from class speiger.src.collections.objects.utils.ObjectSets.UnmodifiableSet

Methods inherited from class speiger.src.collections.objects.utils.ObjectCollections.UnmodifiableCollection

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.lang.Iterable

Method Detail

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

copy

iterator

iterator

first

pollFirst

last

pollLast