Object2BooleanSortedMap (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<T,java.lang.Boolean>, Object2BooleanFunction<T>, Object2BooleanMap<T>, java.util.function.Predicate<T>, java.util.SortedMap<T,java.lang.Boolean>

All Known Subinterfaces:

Object2BooleanNavigableMap<T>

All Known Implementing Classes:

Object2BooleanAVLTreeMap, Object2BooleanMaps.SynchronizedNavigableMap, Object2BooleanMaps.SynchronizedSortedMap, Object2BooleanMaps.UnmodifyableNavigableMap, Object2BooleanMaps.UnmodifyableSortedMap, Object2BooleanRBTreeMap
```
public interface Object2BooleanSortedMap<T>
extends java.util.SortedMap<T,java.lang.Boolean>, Object2BooleanMap<T>
```
A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Note:

Object2BooleanOrderedMap is only extended until 0.6.0 for Compat reasons. The supported classes already implement Object2BooleanOrderedMap directly and will remove Object2BooleanSortedMap implementations in favor of Object2BooleanOrderedMap instead

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Object2BooleanSortedMap.FastSortedSet<T>` Fast Sorted Entry Set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap
Object2BooleanMap.BuilderCache<T>, Object2BooleanMap.Entry<T>, Object2BooleanMap.FastEntrySet<T>, Object2BooleanMap.MapBuilder

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.util.Comparator<T>`	`comparator()`
`Object2BooleanSortedMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`boolean`	`firstBooleanValue()` A method to get the first Value of a Map.
`Object2BooleanSortedMap<T>`	`headMap(T toKey)`
`ObjectSortedSet<T>`	`keySet()`
`boolean`	`lastBooleanValue()` A method to get the last Value of a Map.
`T`	`pollFirstKey()` A method to get and remove the first Key of a Map.
`T`	`pollLastKey()` A method to get and remove the last Key of a Map.
`Object2BooleanSortedMap<T>`	`subMap(T fromKey, T toKey)`
`default Object2BooleanSortedMap<T>`	`synchronize()` Creates a Wrapped SortedMap that is Synchronized
`default Object2BooleanSortedMap<T>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped SortedMap that is Synchronized
`Object2BooleanSortedMap<T>`	`tailMap(T fromKey)`
`default Object2BooleanSortedMap<T>`	`unmodifiable()` Creates a Wrapped SortedMap that is unmodifiable
`BooleanCollection`	`values()`

Methods inherited from interface java.util.SortedMap
entrySet, firstKey, lastKey

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap
builder, compute, computeBoolean, computeBooleanIfAbsent, computeBooleanIfPresent, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getBoolean, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllBoolean, mergeBoolean, object2BooleanEntrySet, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceBooleans, replaceBooleans, setDefaultReturnValue, supplyBooleanIfAbsent

Methods inherited from interface java.util.Map
clear, containsKey, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2BooleanFunction
and, andType, negate, or, orType, test

Methods inherited from interface java.util.function.Predicate
isEqual

- Method Detail
  - comparator
```
java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,java.lang.Boolean>
  - copy
```
Object2BooleanSortedMap<T> copy()
```
    Description copied from interface: Object2BooleanMap
    
    A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface Object2BooleanMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
ObjectSortedSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Boolean>
    
    Specified by:
    
    keySet in interface Object2BooleanMap<T>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<T,java.lang.Boolean>
  - values
```
BooleanCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Boolean>
    
    Specified by:
    
    values in interface Object2BooleanMap<T>
    
    Specified by:
    
    values in interface java.util.SortedMap<T,java.lang.Boolean>
  - synchronize
```
default Object2BooleanSortedMap<T> synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2BooleanMap<T>
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Object2BooleanMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2BooleanMap<T>)
  - synchronize
```
default Object2BooleanSortedMap<T> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2BooleanMap<T>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Object2BooleanMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2BooleanMap<T>)
  - unmodifiable
```
default Object2BooleanSortedMap<T> unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Object2BooleanMap<T>
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Object2BooleanMaps.unmodifiable(speiger.src.collections.objects.maps.interfaces.Object2BooleanMap<T>)
  - pollFirstKey
```
T pollFirstKey()
```
    A method to get and remove the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - pollLastKey
```
T pollLastKey()
```
    A method to get and remove the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - firstBooleanValue
```
boolean firstBooleanValue()
```
    A method to get the first Value of a Map.
    
    Returns:
    
    the first key in the map
  - lastBooleanValue
```
boolean lastBooleanValue()
```
    A method to get the last Value of a Map.
    
    Returns:
    
    the last key in the map
  - subMap
```
Object2BooleanSortedMap<T> subMap(T fromKey,
                                  T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Boolean>
  - headMap
```
Object2BooleanSortedMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Boolean>
  - tailMap
```
Object2BooleanSortedMap<T> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,java.lang.Boolean>

Interface Object2BooleanSortedMap<T>

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap

Method Summary

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2BooleanFunction

Methods inherited from interface java.util.function.Predicate

Method Detail

comparator

copy

keySet

values

synchronize

synchronize

unmodifiable

pollFirstKey

pollLastKey

firstBooleanValue

lastBooleanValue

subMap

headMap

tailMap