Class ImmutableCharShortHashMap
java.lang.Object
org.eclipse.collections.impl.map.immutable.primitive.ImmutableCharShortHashMap
- All Implemented Interfaces:
Serializable, CharShortMap, ImmutableCharShortMap, ShortValuesMap, PrimitiveIterable, ShortIterable
ImmutableCharShortHashMap is the non-modifiable equivalent of
CharShortHashMap.
This file was automatically generated from template file immutablePrimitivePrimitiveHashMap.stg.- Since:
- 4.0.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanallSatisfy(ShortPredicate predicate) Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.booleanallSatisfyKeyValue(CharShortPredicate predicate) booleananySatisfy(ShortPredicate predicate) Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.voidappendString(Appendable appendable) Prints a string representation of this collection onto the givenAppendable.voidappendString(Appendable appendable, String separator) Prints a string representation of this collection onto the givenAppendable.voidappendString(Appendable appendable, String start, String separator, String end) Prints a string representation of this collection onto the givenAppendable.asLazy()Returns a LazyShortIterable adapter wrapping the source ShortIterable.doubleaverage()chunk(int size) Partitions elements in fixed size chunks.<V> ImmutableBag<V> collect(ShortToObjectFunction<? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection.booleancontains(short value) Returns true if the value is contained in the ShortIterable, and false if it is not.booleancontainsAll(short... source) Returns true if all of the values specified in the source array are contained in the ShortIterable, and false if they are not.booleancontainsAll(ShortIterable source) Returns true if all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.booleancontainsKey(char key) Returns whether or not the key is present in the map.booleancontainsValue(short value) Returns whether or not this map contains the value.intcount(ShortPredicate predicate) Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.shortdetectIfNone(ShortPredicate predicate, short ifNone) voideach(ShortProcedure procedure) A synonym for forEach.booleanFollows the same general contract asMap.equals(Object).Return the ShortCharMap that is obtained by flipping the direction of this map and making the associations from value to key.voidforEachKey(CharProcedure procedure) Iterates through each key in the map, invoking the procedure for each.voidforEachKeyValue(CharShortProcedure procedure) Iterates through each key/value pair in the map, invoking the procedure for each.voidforEachValue(ShortProcedure procedure) Iterates through each value in this map.shortget(char key) Retrieves the value associated with the key.shortgetIfAbsent(char key, short ifAbsent) Retrieves the value associated with the key, returning the specified default value if no such mapping exists.shortgetOrThrow(char key) Retrieves the value associated with the key, throwing anIllegalStateExceptionif no such mapping exists.inthashCode()Follows the same general contract asMap.hashCode().<T> TinjectInto(T injectedValue, ObjectShortToObjectFunction<? super T, ? extends T> function) booleanisEmpty()Returns true if this iterable has zero items.keySet()Returns a set containing all the keys in this map.keysView()Returns a view of the keys in this map.Returns a view of the key/value pairs in this map.Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)and defaulting the separator parameter to the characters", "(comma and space).makeString(String separator) Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String, String, String)and defaulting the start and end parameters to""(the empty String).makeString(String start, String separator, String end) Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.shortmax()shortmaxIfEmpty(short defaultValue) doublemedian()shortmin()shortminIfEmpty(short defaultValue) newWithKeyValue(char key, short value) Copy this map, associate the value with the key (replacing the value if one already exists forkey), and return the copy as new immutable map.Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.newWithoutKey(char key) Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.booleannoneSatisfy(ShortPredicate predicate) Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.booleannotEmpty()The English equivalent of !this.isEmpty()reject(CharShortPredicate predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.reject(ShortPredicate predicate) Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.select(CharShortPredicate predicate) Return a copy of this map containing only the key/value pairs that match the predicate.select(ShortPredicate predicate) Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.intsize()Returns the number of items in this iterable.longsum()short[]toArray()Converts the ShortIterable to a primitive short array.short[]toArray(short[] target) Converts the ShortIterable to a primitive short array.toBag()Converts the ShortIterable to a new MutableShortBag.Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.toList()Converts the ShortIterable to a new MutableShortList.toSet()Converts the ShortIterable to a new MutableShortSet.short[]toString()Follows the same general contract asAbstractMap.toString()values()Returns the values in this map as a separate collection.private ObjectMethods inherited from interface CharShortMap
injectIntoKeyValueMethods inherited from interface ShortIterable
averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListByMethods inherited from interface ShortValuesMap
tap
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
delegate
-
-
Constructor Details
-
ImmutableCharShortHashMap
ImmutableCharShortHashMap(CharShortMap delegate)
-
-
Method Details
-
get
public short get(char key) Description copied from interface:CharShortMapRetrieves the value associated with the key. If no mapping exists for the key, the default value (usually0) is returned.- Specified by:
getin interfaceCharShortMap- Parameters:
key- the key- Returns:
- the value associated with the key, or the default value if no such mapping exists
-
getIfAbsent
public short getIfAbsent(char key, short ifAbsent) Description copied from interface:CharShortMapRetrieves the value associated with the key, returning the specified default value if no such mapping exists.- Specified by:
getIfAbsentin interfaceCharShortMap- Parameters:
key- the keyifAbsent- the default value to return if no mapping exists forkey- Returns:
- the value associated with the key, or
ifAbsentif no such mapping exists.
-
getOrThrow
public short getOrThrow(char key) Description copied from interface:CharShortMapRetrieves the value associated with the key, throwing anIllegalStateExceptionif no such mapping exists.- Specified by:
getOrThrowin interfaceCharShortMap- Parameters:
key- the key- Returns:
- the value associated with the key
-
containsKey
public boolean containsKey(char key) Description copied from interface:CharShortMapReturns whether or not the key is present in the map.- Specified by:
containsKeyin interfaceCharShortMap- Parameters:
key- the key- Returns:
- if a mapping exists in this map for the key
-
containsValue
public boolean containsValue(short value) Description copied from interface:ShortValuesMapReturns whether or not this map contains the value.- Specified by:
containsValuein interfaceShortValuesMap- Parameters:
value- the value to test- Returns:
- if this collection contains the value
-
forEachValue
Description copied from interface:ShortValuesMapIterates through each value in this map.- Specified by:
forEachValuein interfaceShortValuesMap- Parameters:
procedure- the procedure to invoke for each value in this map.
-
forEachKey
Description copied from interface:CharShortMapIterates through each key in the map, invoking the procedure for each.- Specified by:
forEachKeyin interfaceCharShortMap- Parameters:
procedure- the procedure to invoke for each key
-
forEachKeyValue
Description copied from interface:CharShortMapIterates through each key/value pair in the map, invoking the procedure for each.- Specified by:
forEachKeyValuein interfaceCharShortMap- Parameters:
procedure- the procedure to invoke for each key/value pair
-
allSatisfyKeyValue
- Specified by:
allSatisfyKeyValuein interfaceCharShortMap- Since:
- 12.0
-
keysView
Description copied from interface:CharShortMapReturns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.- Specified by:
keysViewin interfaceCharShortMap- Returns:
- a view of the keys in this map
-
keyValuesView
Description copied from interface:CharShortMapReturns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.- Specified by:
keyValuesViewin interfaceCharShortMap- Returns:
- a view of the keys in this map
-
flipUniqueValues
Description copied from interface:CharShortMapReturn the ShortCharMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValuesin interfaceCharShortMap- Specified by:
flipUniqueValuesin interfaceImmutableCharShortMap
-
select
Description copied from interface:CharShortMapReturn a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
selectin interfaceCharShortMap- Specified by:
selectin interfaceImmutableCharShortMap- Parameters:
predicate- the predicate to determine which key/value pairs in this map should be included in the returned map- Returns:
- a copy of this map with the matching key/value pairs
-
reject
Description copied from interface:CharShortMapReturn a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
rejectin interfaceCharShortMap- Specified by:
rejectin interfaceImmutableCharShortMap- Parameters:
predicate- the predicate to determine which key/value pairs in this map should be excluded from the returned map- Returns:
- a copy of this map without the matching key/value pairs
-
injectInto
public <T> T injectInto(T injectedValue, ObjectShortToObjectFunction<? super T, ? extends T> function) - Specified by:
injectIntoin interfaceShortIterable
-
chunk
Description copied from interface:ShortIterablePartitions elements in fixed size chunks.- Specified by:
chunkin interfaceShortIterable- Parameters:
size- the number of elements per chunk- Returns:
- A
RichIterablecontainingShortIterables of sizesize, except the last will be truncated if the elements don't divide evenly.
-
toImmutable
Description copied from interface:CharShortMapReturns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.- Specified by:
toImmutablein interfaceCharShortMap- Returns:
- an immutable map that is equivalent to this one
-
shortIterator
Description copied from interface:ShortIterableReturns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.- Specified by:
shortIteratorin interfaceShortIterable
-
each
Description copied from interface:ShortIterableA synonym for forEach.- Specified by:
eachin interfaceShortIterable- Since:
- 7.0.
-
count
Description copied from interface:ShortIterableReturns a count of the number of elements in the ShortIterable that return true for the specified predicate.- Specified by:
countin interfaceShortIterable
-
anySatisfy
Description copied from interface:ShortIterableReturns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.- Specified by:
anySatisfyin interfaceShortIterable
-
allSatisfy
Description copied from interface:ShortIterableReturns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.- Specified by:
allSatisfyin interfaceShortIterable
-
noneSatisfy
Description copied from interface:ShortIterableReturns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.- Specified by:
noneSatisfyin interfaceShortIterable
-
select
Description copied from interface:ShortIterableReturns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.- Specified by:
selectin interfaceImmutableCharShortMap- Specified by:
selectin interfaceShortIterable- Specified by:
selectin interfaceShortValuesMap
-
reject
Description copied from interface:ShortIterableReturns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.- Specified by:
rejectin interfaceImmutableCharShortMap- Specified by:
rejectin interfaceShortIterable- Specified by:
rejectin interfaceShortValuesMap
-
collect
Description copied from interface:ShortIterableReturns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.- Specified by:
collectin interfaceImmutableCharShortMap- Specified by:
collectin interfaceShortIterable- Specified by:
collectin interfaceShortValuesMap
-
detectIfNone
- Specified by:
detectIfNonein interfaceShortIterable
-
sum
public long sum()- Specified by:
sumin interfaceShortIterable
-
max
public short max()- Specified by:
maxin interfaceShortIterable
-
maxIfEmpty
public short maxIfEmpty(short defaultValue) - Specified by:
maxIfEmptyin interfaceShortIterable
-
min
public short min()- Specified by:
minin interfaceShortIterable
-
minIfEmpty
public short minIfEmpty(short defaultValue) - Specified by:
minIfEmptyin interfaceShortIterable
-
average
public double average()- Specified by:
averagein interfaceShortIterable
-
median
public double median()- Specified by:
medianin interfaceShortIterable
-
toSortedArray
public short[] toSortedArray()- Specified by:
toSortedArrayin interfaceShortIterable
-
toSortedList
- Specified by:
toSortedListin interfaceShortIterable
-
toArray
public short[] toArray()Description copied from interface:ShortIterableConverts the ShortIterable to a primitive short array.- Specified by:
toArrayin interfaceShortIterable
-
toArray
public short[] toArray(short[] target) Description copied from interface:ShortIterableConverts the ShortIterable to a primitive short array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.- Specified by:
toArrayin interfaceShortIterable
-
contains
public boolean contains(short value) Description copied from interface:ShortIterableReturns true if the value is contained in the ShortIterable, and false if it is not.- Specified by:
containsin interfaceShortIterable
-
containsAll
public boolean containsAll(short... source) Description copied from interface:ShortIterableReturns true if all of the values specified in the source array are contained in the ShortIterable, and false if they are not.- Specified by:
containsAllin interfaceShortIterable
-
containsAll
Description copied from interface:ShortIterableReturns true if all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.- Specified by:
containsAllin interfaceShortIterable
-
toList
Description copied from interface:ShortIterableConverts the ShortIterable to a new MutableShortList.- Specified by:
toListin interfaceShortIterable
-
toSet
Description copied from interface:ShortIterableConverts the ShortIterable to a new MutableShortSet.- Specified by:
toSetin interfaceShortIterable
-
toBag
Description copied from interface:ShortIterableConverts the ShortIterable to a new MutableShortBag.- Specified by:
toBagin interfaceShortIterable
-
asLazy
Description copied from interface:ShortIterableReturns a LazyShortIterable adapter wrapping the source ShortIterable.- Specified by:
asLazyin interfaceShortIterable
-
newWithKeyValue
Description copied from interface:ImmutableCharShortMapCopy this map, associate the value with the key (replacing the value if one already exists forkey), and return the copy as new immutable map. A copy is always made even ifkeyis already associated withvalue.- Specified by:
newWithKeyValuein interfaceImmutableCharShortMap- Parameters:
key- the key to addvalue- the value to associate with the key in the copy- Returns:
- an immutable copy of this map with
valueassociated withkey
-
newWithoutKey
Description copied from interface:ImmutableCharShortMapCopy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.- Specified by:
newWithoutKeyin interfaceImmutableCharShortMap- Parameters:
key- the key to remove- Returns:
- an immutable copy of this map with
keyremoved
-
newWithoutAllKeys
Description copied from interface:ImmutableCharShortMapCopy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.- Specified by:
newWithoutAllKeysin interfaceImmutableCharShortMap- Parameters:
keys- the keys to remove- Returns:
- an immutable copy of this map with all keys in
keysremoved
-
size
public int size()Description copied from interface:PrimitiveIterableReturns the number of items in this iterable.- Specified by:
sizein interfacePrimitiveIterable
-
isEmpty
public boolean isEmpty()Description copied from interface:PrimitiveIterableReturns true if this iterable has zero items.- Specified by:
isEmptyin interfacePrimitiveIterable
-
notEmpty
public boolean notEmpty()Description copied from interface:PrimitiveIterableThe English equivalent of !this.isEmpty()- Specified by:
notEmptyin interfacePrimitiveIterable
-
makeString
Description copied from interface:PrimitiveIterableReturns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)and defaulting the separator parameter to the characters", "(comma and space).- Specified by:
makeStringin interfacePrimitiveIterable- Returns:
- a string representation of this collection.
-
makeString
Description copied from interface:PrimitiveIterableReturns a string representation of this collection by delegating toPrimitiveIterable.makeString(String, String, String)and defaulting the start and end parameters to""(the empty String).- Specified by:
makeStringin interfacePrimitiveIterable- Returns:
- a string representation of this collection.
-
makeString
Description copied from interface:PrimitiveIterableReturns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.- Specified by:
makeStringin interfacePrimitiveIterable- Returns:
- a string representation of this collection.
-
appendString
Description copied from interface:PrimitiveIterablePrints a string representation of this collection onto the givenAppendable. Prints the string returned byPrimitiveIterable.makeString().- Specified by:
appendStringin interfacePrimitiveIterable
-
appendString
Description copied from interface:PrimitiveIterablePrints a string representation of this collection onto the givenAppendable. Prints the string returned byPrimitiveIterable.makeString(String).- Specified by:
appendStringin interfacePrimitiveIterable
-
appendString
Description copied from interface:PrimitiveIterablePrints a string representation of this collection onto the givenAppendable. Prints the string returned byPrimitiveIterable.makeString(String, String, String).- Specified by:
appendStringin interfacePrimitiveIterable
-
keySet
Description copied from interface:CharShortMapReturns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.- Specified by:
keySetin interfaceCharShortMap- Returns:
- a mutable set containing the keys in this map
-
values
Description copied from interface:ShortValuesMapReturns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.- Specified by:
valuesin interfaceShortValuesMap- Returns:
- the values as a collection backed by this map
-
equals
Description copied from interface:CharShortMapFollows the same general contract asMap.equals(Object).- Specified by:
equalsin interfaceCharShortMap- Overrides:
equalsin classObject
-
hashCode
public int hashCode()Description copied from interface:CharShortMapFollows the same general contract asMap.hashCode().- Specified by:
hashCodein interfaceCharShortMap- Overrides:
hashCodein classObject
-
toString
Description copied from interface:CharShortMapFollows the same general contract asAbstractMap.toString()- Specified by:
toStringin interfaceCharShortMap- Specified by:
toStringin interfacePrimitiveIterable- Overrides:
toStringin classObject- Returns:
- a string representation of this CharShortMap
- See Also:
-
writeReplace
-