com.gs.collections.api.map.primitive

Interface MutableShortObjectMap<V>

All Superinterfaces:

InternalIterable<V>, Iterable<V>, MutablePrimitiveObjectMap<V>, RichIterable<V>, ShortObjectMap<V>

All Known Implementing Classes:

ShortObjectHashMap, SynchronizedShortObjectMap, UnmodifiableShortObjectMap

public interface MutableShortObjectMap<V>
extends ShortObjectMap<V>, MutablePrimitiveObjectMap<V>

This file was automatically generated from template file mutablePrimitiveObjectMap.stg.

Since:

3.0.

Method Summary

Modifier and Type	Method and Description
MutableShortObjectMap<V>	asSynchronized()
MutableShortObjectMap<V>	asUnmodifiable()
<V1> MutableCollection<V1>	collect(Function<? super V,? extends V1> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
<P,VV> MutableCollection<VV>	collectWith(Function2<? super V,? super P,? extends VV> function, P parameter) Same as collect with a Function2 and specified parameter which is passed to the block
V	getIfAbsentPut(short key, Function0<? extends V> function)
V	getIfAbsentPut(short key, V value)
<P> V	getIfAbsentPutWith(short key, Function<? super P,? extends V> function, P parameter)
V	getIfAbsentPutWithKey(short key, ShortToObjectFunction<? extends V> function)
V	put(short key, V value)
void	putAll(ShortObjectMap<? extends V> map)
MutableCollection<V>	reject(Predicate<? super V> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
MutableShortObjectMap<V>	reject(ShortObjectPredicate<? super V> predicate)
V	remove(short key)
V	removeKey(short key)
MutableCollection<V>	select(Predicate<? super V> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
MutableShortObjectMap<V>	select(ShortObjectPredicate<? super V> predicate)
V	updateValue(short key, Function0<? extends V> factory, Function<? super V,? extends V> function) Look up the value associated with key, apply the function to it, and replace the value.
<P> V	updateValueWith(short key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter) Same as updateValue(short, Function0, Function) with a Function2 and specified parameter which is passed to the function.
MutableShortObjectMap<V>	withKeyValue(short key, V value)
MutableShortObjectMap<V>	withoutAllKeys(ShortIterable keys)
MutableShortObjectMap<V>	withoutKey(short key)

Methods inherited from interface com.gs.collections.api.map.primitive.ShortObjectMap

containsKey, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, hashCode, keySet, keysView, keyValuesView, toImmutable, toString, values

Methods inherited from interface com.gs.collections.api.RichIterable

aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, flatCollect, getFirst, getLast, groupBy, groupBy, groupByEach, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, partition, partitionWith, reject, rejectWith, rejectWith, select, selectInstancesOf, selectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zip, zipWithIndex, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.gs.collections.api.map.primitive.MutablePrimitiveObjectMap

aggregateBy, aggregateInPlaceBy, clear, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, rejectWith, selectInstancesOf, selectWith, zip, zipWithIndex

Method Detail

put

V put(short key,
      V value)

putAll

void putAll(ShortObjectMap<? extends V> map)

Since:

5.0.

removeKey

V removeKey(short key)

remove

V remove(short key)

getIfAbsentPut

V getIfAbsentPut(short key,
                 V value)

getIfAbsentPut

V getIfAbsentPut(short key,
                 Function0<? extends V> function)

getIfAbsentPutWithKey

V getIfAbsentPutWithKey(short key,
                        ShortToObjectFunction<? extends V> function)

getIfAbsentPutWith

<P> V getIfAbsentPutWith(short key,
                         Function<? super P,? extends V> function,
                         P parameter)

updateValue

V updateValue(short key,
              Function0<? extends V> factory,
              Function<? super V,? extends V> function)

Look up the value associated with key, apply the function to it, and replace the value. If there is no value associated with key, start it off with a value supplied by factory.

updateValueWith

<P> V updateValueWith(short key,
                      Function0<? extends V> factory,
                      Function2<? super V,? super P,? extends V> function,
                      P parameter)

Same as updateValue(short, Function0, Function) with a Function2 and specified parameter which is passed to the function.

select

MutableShortObjectMap<V> select(ShortObjectPredicate<? super V> predicate)

Specified by:

select in interface ShortObjectMap<V>

reject

MutableShortObjectMap<V> reject(ShortObjectPredicate<? super V> predicate)

Specified by:

reject in interface ShortObjectMap<V>

select

MutableCollection<V> select(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 

Specified by:

select in interface MutablePrimitiveObjectMap<V>

Specified by:

select in interface RichIterable<V>

reject

MutableCollection<V> reject(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 

e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 

Specified by:

reject in interface MutablePrimitiveObjectMap<V>

Specified by:

reject in interface RichIterable<V>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

collect

<V1> MutableCollection<V1> collect(Function<? super V,? extends V1> function)

Description copied from interface: RichIterable

Returns 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.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

collect in interface MutablePrimitiveObjectMap<V>

Specified by:

collect in interface RichIterable<V>

collectWith

<P,VV> MutableCollection<VV> collectWith(Function2<? super V,? super P,? extends VV> function,
                                         P parameter)

Description copied from interface: RichIterable

Same as collect with a Function2 and specified parameter which is passed to the block

e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

collectWith in interface MutablePrimitiveObjectMap<V>

Specified by:

collectWith in interface RichIterable<V>

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

RichIterable.collect(Function)

withKeyValue

MutableShortObjectMap<V> withKeyValue(short key,
                                      V value)

withoutKey

MutableShortObjectMap<V> withoutKey(short key)

withoutAllKeys

MutableShortObjectMap<V> withoutAllKeys(ShortIterable keys)

asUnmodifiable

MutableShortObjectMap<V> asUnmodifiable()

asSynchronized

MutableShortObjectMap<V> asSynchronized()