Class UnmodifiableCharShortMap

    • Constructor Detail

    • Method Detail

      • put

        public void put​(char key,
                        short value)
        Description copied from interface: MutableCharShortMap
        Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
        Specified by:
        put in interface MutableCharShortMap
        Parameters:
        key - the key
        value - the value to associate with value
      • putAll

        public void putAll​(CharShortMap map)
        Description copied from interface: MutableCharShortMap
        Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.
        Specified by:
        putAll in interface MutableCharShortMap
        Parameters:
        map - the map to copy into this map
      • removeKeyIfAbsent

        public short removeKeyIfAbsent​(char key,
                                       short value)
        Description copied from interface: MutableCharShortMap
        Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.
        Specified by:
        removeKeyIfAbsent in interface MutableCharShortMap
        Parameters:
        key - the key to remove
        value - the default value to return if no mapping for the key exists
        Returns:
        the value previously associated with the key, if one existed, or value if not
      • getIfAbsentPut

        public short getIfAbsentPut​(char key,
                                    short value)
        Description copied from interface: MutableCharShortMap
        Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
        Specified by:
        getIfAbsentPut in interface MutableCharShortMap
        Parameters:
        key - the key
        value - the value to associate with key if no such mapping exists
        Returns:
        the value associated with key, if one exists, or value if not
      • getAndPut

        public short getAndPut​(char key,
                               short putValue,
                               short defaultValue)
        Description copied from interface: MutableCharShortMap
        Retrieves the value associated with the key if one exists; associates a putValue with the key.
        Specified by:
        getAndPut in interface MutableCharShortMap
        Parameters:
        key - the key
        putValue - the value to associate with key if no such mapping exists
        defaultValue - the value to return if no mapping associated with key exists
        Returns:
        the value associated with key, if one exists, or defaultValue if not
      • getIfAbsentPut

        public short getIfAbsentPut​(char key,
                                    ShortFunction0 function)
        Description copied from interface: MutableCharShortMap
        Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
        Specified by:
        getIfAbsentPut in interface MutableCharShortMap
        Parameters:
        key - the key
        function - the supplier that provides the value if no mapping exists for key
        Returns:
        the value associated with the key, if one exists, or the result of invoking function if not
      • getIfAbsentPutWithKey

        public short getIfAbsentPutWithKey​(char key,
                                           CharToShortFunction function)
        Description copied from interface: MutableCharShortMap
        Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
        Specified by:
        getIfAbsentPutWithKey in interface MutableCharShortMap
        Parameters:
        key - the key
        function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.
        Returns:
        the value associated with the key, if one exists, or the result of invoking function with key if not
      • getIfAbsentPutWith

        public <P> short getIfAbsentPutWith​(char key,
                                            ShortFunction<? super P> function,
                                            P parameter)
        Description copied from interface: MutableCharShortMap
        Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
        Specified by:
        getIfAbsentPutWith in interface MutableCharShortMap
        Type Parameters:
        P - the type of the value function's parameter
        Parameters:
        key - the key
        function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
        parameter - the parameter to provide to function if no value exists for key
        Returns:
        the value associated with the key, if one exists, or the result of invoking function with parameter if not
      • updateValue

        public short updateValue​(char key,
                                 short initialValueIfAbsent,
                                 ShortToShortFunction function)
        Description copied from interface: MutableCharShortMap
        Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.
        Specified by:
        updateValue in interface MutableCharShortMap
        Parameters:
        key - the key
        initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key
        function - the function that returns the updated value based on the current value or the initial value, if no value exists
        Returns:
        the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to initialValueIfAbsent and associating the result with key
      • get

        public short get​(char key)
        Description copied from interface: CharShortMap
        Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.
        Specified by:
        get in interface CharShortMap
        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: CharShortMap
        Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
        Specified by:
        getIfAbsent in interface CharShortMap
        Parameters:
        key - the key
        ifAbsent - the default value to return if no mapping exists for key
        Returns:
        the value associated with the key, or ifAbsent if no such mapping exists.
      • getOrThrow

        public short getOrThrow​(char key)
        Description copied from interface: CharShortMap
        Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
        Specified by:
        getOrThrow in interface CharShortMap
        Parameters:
        key - the key
        Returns:
        the value associated with the key
      • containsKey

        public boolean containsKey​(char key)
        Description copied from interface: CharShortMap
        Returns whether or not the key is present in the map.
        Specified by:
        containsKey in interface CharShortMap
        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: ShortValuesMap
        Returns whether or not this map contains the value.
        Specified by:
        containsValue in interface ShortValuesMap
        Parameters:
        value - the value to test
        Returns:
        if this collection contains the value
      • forEachValue

        public void forEachValue​(ShortProcedure procedure)
        Description copied from interface: ShortValuesMap
        Iterates through each value in this map.
        Specified by:
        forEachValue in interface ShortValuesMap
        Parameters:
        procedure - the procedure to invoke for each value in this map.
      • forEachKey

        public void forEachKey​(CharProcedure procedure)
        Description copied from interface: CharShortMap
        Iterates through each key in the map, invoking the procedure for each.
        Specified by:
        forEachKey in interface CharShortMap
        Parameters:
        procedure - the procedure to invoke for each key
      • forEachKeyValue

        public void forEachKeyValue​(CharShortProcedure procedure)
        Description copied from interface: CharShortMap
        Iterates through each key/value pair in the map, invoking the procedure for each.
        Specified by:
        forEachKeyValue in interface CharShortMap
        Parameters:
        procedure - the procedure to invoke for each key/value pair
      • keysView

        public LazyCharIterable keysView()
        Description copied from interface: CharShortMap
        Returns 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:
        keysView in interface CharShortMap
        Returns:
        a view of the keys in this map
      • keyValuesView

        public RichIterable<CharShortPair> keyValuesView()
        Description copied from interface: CharShortMap
        Returns 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:
        keyValuesView in interface CharShortMap
        Returns:
        a view of the keys in this map
      • select

        public MutableCharShortMap select​(CharShortPredicate predicate)
        Description copied from interface: CharShortMap
        Return a copy of this map containing only the key/value pairs that match the predicate.
        Specified by:
        select in interface CharShortMap
        Specified by:
        select in interface MutableCharShortMap
        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

        public MutableCharShortMap reject​(CharShortPredicate predicate)
        Description copied from interface: CharShortMap
        Return a copy of this map containing only the key/value pairs that do not match the predicate.
        Specified by:
        reject in interface CharShortMap
        Specified by:
        reject in interface MutableCharShortMap
        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
      • count

        public int count​(ShortPredicate predicate)
        Description copied from interface: ShortIterable
        Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.
        Specified by:
        count in interface ShortIterable
      • anySatisfy

        public boolean anySatisfy​(ShortPredicate predicate)
        Description copied from interface: ShortIterable
        Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
        Specified by:
        anySatisfy in interface ShortIterable
      • allSatisfy

        public boolean allSatisfy​(ShortPredicate predicate)
        Description copied from interface: ShortIterable
        Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
        Specified by:
        allSatisfy in interface ShortIterable
      • noneSatisfy

        public boolean noneSatisfy​(ShortPredicate predicate)
        Description copied from interface: ShortIterable
        Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
        Specified by:
        noneSatisfy in interface ShortIterable
      • maxIfEmpty

        public short maxIfEmpty​(short defaultValue)
        Specified by:
        maxIfEmpty in interface ShortIterable
      • minIfEmpty

        public short minIfEmpty​(short defaultValue)
        Specified by:
        minIfEmpty in interface ShortIterable
      • addToValue

        public short addToValue​(char key,
                                short toBeAdded)
        Description copied from interface: MutableCharShortMap
        Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.
        Specified by:
        addToValue in interface MutableCharShortMap
        Parameters:
        key - the key
        toBeAdded - the amount to increment the existing value, if one exists, or to use as the initial value if one does not
        Returns:
        the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not
      • toArray

        public short[] toArray()
        Description copied from interface: ShortIterable
        Converts the ShortIterable to a primitive short array.
        Specified by:
        toArray in interface ShortIterable
      • toArray

        public short[] toArray​(short[] target)
        Description copied from interface: ShortIterable
        Converts 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:
        toArray in interface ShortIterable
      • contains

        public boolean contains​(short value)
        Description copied from interface: ShortIterable
        Returns true if the value is contained in the ShortIterable, and false if it is not.
        Specified by:
        contains in interface ShortIterable
      • containsAll

        public boolean containsAll​(short... source)
        Description copied from interface: ShortIterable
        Returns true if all of the values specified in the source array are contained in the ShortIterable, and false if they are not.
        Specified by:
        containsAll in interface ShortIterable
      • containsAll

        public boolean containsAll​(ShortIterable source)
        Description copied from interface: ShortIterable
        Returns true if all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.
        Specified by:
        containsAll in interface ShortIterable
      • asUnmodifiable

        public MutableCharShortMap asUnmodifiable()
        Description copied from interface: MutableCharShortMap
        Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling CharShortMap.toImmutable() while still providing immutability.
        Specified by:
        asUnmodifiable in interface MutableCharShortMap
        Returns:
        an unmodifiable view of this map
      • asSynchronized

        public MutableCharShortMap asSynchronized()
        Description copied from interface: MutableCharShortMap
        Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
        Specified by:
        asSynchronized in interface MutableCharShortMap
        Returns:
        a synchronized view of this map
      • toImmutable

        public ImmutableCharShortMap toImmutable()
        Description copied from interface: CharShortMap
        Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
        Specified by:
        toImmutable in interface CharShortMap
        Returns:
        an immutable map that is equivalent to this one
      • keySet

        public MutableCharSet keySet()
        Description copied from interface: CharShortMap
        Returns 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:
        keySet in interface CharShortMap
        Returns:
        a mutable set containing the keys in this map
      • values

        public MutableShortCollection values()
        Description copied from interface: ShortValuesMap
        Returns 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:
        values in interface ShortValuesMap
        Returns:
        the values as a collection backed by this map
      • equals

        public boolean equals​(java.lang.Object otherMap)
        Description copied from interface: CharShortMap
        Follows the same general contract as Map.equals(Object).
        Specified by:
        equals in interface CharShortMap
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Description copied from interface: CharShortMap
        Follows the same general contract as Map.hashCode().
        Specified by:
        hashCode in interface CharShortMap
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Description copied from interface: CharShortMap
        Follows the same general contract as AbstractMap.toString()
        Specified by:
        toString in interface CharShortMap
        Specified by:
        toString in interface PrimitiveIterable
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this CharShortMap
        See Also:
        AbstractCollection.toString()
      • makeString

        public java.lang.String makeString()
        Description copied from interface: PrimitiveIterable
        Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
        Specified by:
        makeString in interface PrimitiveIterable
        Returns:
        a string representation of this collection.
      • makeString

        public java.lang.String makeString​(java.lang.String start,
                                           java.lang.String separator,
                                           java.lang.String end)
        Description copied from interface: PrimitiveIterable
        Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
        Specified by:
        makeString in interface PrimitiveIterable
        Returns:
        a string representation of this collection.
      • chunk

        public RichIterable<ShortIterable> chunk​(int size)
        Description copied from interface: ShortIterable
        Partitions elements in fixed size chunks.
        Specified by:
        chunk in interface ShortIterable
        Parameters:
        size - the number of elements per chunk
        Returns:
        A RichIterable containing ShortIterables of size size, except the last will be truncated if the elements don't divide evenly.