MapProxy

Adds key/value pairs to this map, returning a new map.

This method takes two or more key/value pairs. Another overloaded variant of this method handles the case where a single key/value pair is added.

Adds a key/value pair to this map, returning a new map.

Adds all key/value pairs in a traversable collection to this map, returning a new map.

Returns a new map containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the map is the most specific superclass encompassing the element types of the two operands.

Example:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = List(2)
b: List[Int] = List(2)

scala> val c = a ++ b
c: List[Int] = List(1, 2)

scala> val d = List('a')
d: List[Char] = List(a)

scala> val e = c ++ d
e: List[AnyVal] = List(1, 2, a)

As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

Since TraversableOnce has no ++ method, we have to implement that directly, but Traversable and down can use the overload.

As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

Removes a key from this map, returning a new map.

Creates a new collection from this collection with some elements removed.

This method takes two or more elements to be removed. Another overloaded variant of this method handles the case where a single element is removed.

Creates a new collection from this collection by removing all elements of another collection.

Applies a binary operator to a start value and all elements of this traversable collection, going left to right.

Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

Applies a binary operator to all elements of this traversable collection and a start value, going right to left.

Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15

Appends all elements of this map to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this map are separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)

Appends all elements of this traversable collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this traversable collection without any separator string.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234

Appends all elements of this traversable collection to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this traversable collection, separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4

Aggregates the results of applying an operator to subsequent elements.

This is a more general form of fold and reduce. It is similar to foldLeft in that it doesn't require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.

aggregate splits the traversable or iterator into partitions and processes each partition by sequentially applying seqop, starting with z (like foldLeft). Those intermediate results are then combined by using combop (like fold). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop may be invoked an arbitrary number of times (even 0).

As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop transforms each input character to an Int and adds it to the sum (of the partition). Then, combop just needs to sum up the intermediate results of the partitions:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })

Composes this partial function with a transformation function that gets applied to results of this partial function.

Retrieves the value which is associated with the given key. This method invokes the default method of the map if there is no mapping from the given key to a value. Unless overridden, the default method throws a NoSuchElementException.

Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.

Note that expression pf.applyOrElse(x, default) is equivalent to

if(pf isDefinedAt x) pf(x) else default(x)

except that applyOrElse method can be implemented more efficiently. For all partial function literals the compiler generates an applyOrElse implementation which avoids double evaluation of pattern matchers and guards. This makes applyOrElse the basis for the efficient implementation for many operations and scenarios, such as:

• combining partial functions into orElse/andThen chains does not lead to excessive apply/isDefinedAt evaluation
• lift and unlift do not evaluate source functions twice on each invocation
• runWith allows efficient imperative-style combining of partial functions with conditionally applied actions

For non-literal partial function classes with nontrivial isDefinedAt method it is recommended to override applyOrElse with custom implementation that avoids double isDefinedAt evaluation. This may result in better performance and more predictable behavior w.r.t. side effects.

Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

Builds a new collection by applying a partial function to all elements of this map on which the function is defined.

Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

The factory companion object that builds instances of class Iterable. (or its Iterable superclass where class Iterable is not a Seq.)

Composes two instances of Function1 in a new Function1, with this function applied last.

Tests whether this map contains a binding for a key.

Copies the elements of this map to an array. Fills the given array xs with values of this map. Copying will stop once either the end of the current map is reached, or the end of the target array is reached.

Copies the elements of this map to an array. Fills the given array xs with values of this map, beginning at index start. Copying will stop once either the end of the current map is reached, or the end of the target array is reached.

Copies the elements of this map to an array. Fills the given array xs with at most len elements of this map, starting at position start. Copying will stop once either the end of the current map is reached, or the end of the target array is reached, or len elements have been copied.

Copies all elements of this traversable collection to a buffer.

Note: will not terminate for infinite-sized collections.

Counts the number of elements in the traversable collection which satisfy a predicate.

Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.

Selects all elements except first n ones.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Selects all elements except last n ones.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Drops longest prefix of elements that satisfy a predicate.

Note: might return different results for different runs, unless the underlying collection type is ordered.

The empty map of the same type as this map

Tests whether a predicate holds for at least one element of this traversable collection.

Note: may not terminate for infinite-sized collections.

Selects all elements of this traversable collection which satisfy a predicate.

Filters this map by retaining only keys satisfying a predicate.

Selects all elements of this map which do not satisfy a predicate.

Finds the first element of the traversable collection satisfying a predicate, if any.

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Builds a new collection by applying a function to all elements of this map and using the elements of the resulting collections.

For example:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

The type of the resulting collection is guided by the static type of map. This might cause unexpected results sometimes. For example:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)

Converts this map of traversable collections into a map formed by the elements of these traversable collections.

The resulting collection's type will be guided by the static type of map. For example:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)

Folds the elements of this traversable or iterator using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Note: will not terminate for infinite-sized collections.

Applies a binary operator to a start value and all elements of this traversable collection, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

Applies a binary operator to all elements of this traversable collection and a start value, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

Tests whether a predicate holds for all elements of this traversable collection.

Note: may not terminate for infinite-sized collections.

Applies a function f to all elements of this map.

Note: this method underlies the implementation of most other bulk operations. It's important to implement this method in an efficient way.

The generic builder that builds instances of Traversable at arbitrary element types.

Optionally returns the value associated with a key.

Returns the value associated with a key, or a default value if the key is not contained in the map.

Partitions this traversable collection into a map of traversable collections according to some discriminator function.

Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.

Partitions elements in fixed size iterable collections.

Tests whether this traversable collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end. Non-empty Iterators usually return false even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns true. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

Selects the first element of this traversable collection.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Optionally selects the first element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Selects all elements except the last.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Iterates over the inits of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of init.

Tests whether this map contains a binding for a key. This method, which implements an abstract method of trait PartialFunction, is equivalent to contains.

Tests whether this map is empty.

Tests whether this traversable collection can be repeatedly traversed.

Creates a new iterator over all elements contained in this iterable object.

Collects all keys of this map in a set.

Collects all keys of this map in an iterable collection.

Creates an iterator for all keys.

Selects the last element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Optionally selects the last element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Turns this partial function into a plain function returning an Option result.

Builds a new collection by applying a function to all elements of this map.

Transforms this map by applying a function to every retrieved value.

Finds the largest element.

Finds the first element which yields the largest value measured by function f.

Finds the smallest element.

Finds the first element which yields the smallest value measured by function f.

Displays all elements of this traversable collection in a string.

Displays all elements of this traversable collection in a string using a separator string.

Displays all elements of this traversable collection in a string using start, end, and separator strings.

A common implementation of newBuilder for all maps in terms of empty. Overridden for mutable maps in mutable.MapLike.

Tests whether the traversable collection is not empty.

Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

Returns a parallel implementation of this collection.

For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

Specific collections (e.g. ParArray or mutable.ParHashMap) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

All parallel collections return a reference to themselves.

The default par implementation uses the combiner provided by this method to create a new parallel collection.

Partitions this traversable collection in two traversable collections according to a predicate.

Multiplies up the elements of this collection.

Reduces the elements of this traversable or iterator using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Applies a binary operator to all elements of this traversable collection, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

Optionally applies a binary operator to all elements of this traversable collection, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Applies a binary operator to all elements of this traversable collection, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

Optionally applies a binary operator to all elements of this traversable collection, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

The collection of type traversable collection underlying this TraversableLike object. By default this is implemented as the TraversableLike object itself, but this can be overridden.

Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.

Note that expression pf.runWith(action)(x) is equivalent to

if(pf isDefinedAt x) { action(pf(x)); true } else false

except that runWith is implemented via applyOrElse and thus potentially more efficient. Using runWith avoids double evaluation of pattern matchers and guards for partial function literals.

Checks if the other iterable collection contains the same elements in the same order as this map.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Computes a prefix scan of the elements of the collection.

Note: The neutral element z may be applied more than once.

Produces a collection containing cumulative results of applying the operator going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Example:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)

A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).

This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

The size of this traversable collection.

Note: will not terminate for infinite-sized collections.

Selects an interval of elements. The returned collection is made up of all elements x which satisfy the invariant:

from <= indexOf(x) < until

Note: might return different results for different runs, unless the underlying collection type is ordered.

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.) "Sliding window" step is 1 by default.

Splits this traversable collection into a prefix/suffix pair according to a predicate.

Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side-effects.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Splits this traversable collection into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

Note: might return different results for different runs, unless the underlying collection type is ordered.

Defines the prefix of this object's toString representation.

Sums up the elements of this collection.

Selects all elements except the first.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Iterates over the tails of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of tail.

Selects first n elements.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Selects last n elements.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Takes longest prefix of elements that satisfy a predicate.

Note: might return different results for different runs, unless the underlying collection type is ordered.

The underlying collection seen as an instance of Iterable. By default this is implemented as the current collection object itself, but this can be overridden.

Converts this map into another by copying all elements.

Converts this map to an array.

Uses the contents of this traversable collection to create a new mutable buffer.

Note: will not terminate for infinite-sized collections.

A conversion from collections of type Repr to Iterable objects. By default this is implemented as just a cast, but this can be overridden.

Converts this traversable collection to an indexed sequence.

Note: will not terminate for infinite-sized collections.

Converts this traversable collection to an iterable collection. Note that the choice of target Iterable is lazy in this default implementation as this TraversableOnce may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).

Note: will not terminate for infinite-sized collections.

Returns an Iterator over the elements in this traversable collection. Will return the same Iterator if this instance is already an Iterator.

Note: will not terminate for infinite-sized collections.

Converts this traversable collection to a list.

Note: will not terminate for infinite-sized collections.

Converts this map to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

Converts this traversable collection to a sequence. As with toIterable, it's lazy in this default implementation, as this TraversableOnce may be lazy and unevaluated.

Note: will not terminate for infinite-sized collections.

Converts this traversable collection to a set.

Note: will not terminate for infinite-sized collections.

Converts this traversable collection to a stream.

Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.

Note: will not terminate for infinite-sized collections.

Converts this traversable or iterator to a Vector.

Note: will not terminate for infinite-sized collections.

Transposes this collection of traversable collections into a collection of collections.

The resulting collection's type will be guided by the static type of collection. For example:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

Converts this collection of pairs into two collections of the first and second half of each pair.

val xs = Traversable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three))

Converts this collection of triples into three collections of the first, second, and third element of each triple.

val xs = Traversable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three),
//        Traversable(1, 2, 3))

Creates a new map obtained by updating this map with a given key/value pair.

Collects all values of this map in an iterable collection.

Creates an iterator for all values in this map.

Creates a non-strict view of a slice of this iterable collection.

Note: the difference between view and slice is that view produces a view of the current iterable collection, whereas slice produces a new iterable collection.

Note: view(from, to) is equivalent to view.slice(from, to)

Note: might return different results for different runs, unless the underlying collection type is ordered.

Creates a non-strict view of this iterable collection.

Creates a non-strict filter of this traversable collection.

Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Zips this map with its indices.

Note: might return different results for different runs, unless the underlying collection type is ordered.