Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalatest

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    org
  • package compatible
    Definition Classes
    scalatest
  • package concurrent

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    scalatest
  • package enablers
    Definition Classes
    scalatest
  • package events
    Definition Classes
    scalatest
  • package exceptions
    Definition Classes
    scalatest
  • package featurespec
    Definition Classes
    scalatest
  • package fixture

    Package fixture deprecated types.

    Package fixture deprecated types.

    Definition Classes
    scalatest
  • package flatspec
    Definition Classes
    scalatest
  • package freespec
    Definition Classes
    scalatest
  • package funspec
    Definition Classes
    scalatest
  • package funsuite
    Definition Classes
    scalatest
  • package matchers
    Definition Classes
    scalatest
  • package path
    Definition Classes
    scalatest
  • package prop

    Scalatest support for Property-based testing.

    Scalatest support for Property-based testing.

    Introduction to Property-based Testing

    In traditional unit testing, you write tests that describe precisely what the test will do: create these objects, wire them together, call these functions, assert on the results, and so on. It is clear and deterministic, but also limited, because it only covers the exact situations you think to test. In most cases, it is not feasible to test all of the possible combinations of data that might arise in real-world use.

    Property-based testing works the other way around. You describe properties -- rules that you expect your classes to live by -- and describe how to test those properties. The test system then generates relatively large amounts of synthetic data (with an emphasis on edge cases that tend to make things break), so that you can see if the properties hold true in these situations.

    As a result, property-based testing is scientific in the purest sense: you are stating a hypothesis about how things should work (the property), and the system is trying to falsify that hypothesis. If the tests pass, that doesn't prove the property holds, but it at least gives you some confidence that you are probably correct.

    Property-based testing is deliberately a bit random: while the edge cases get tried upfront, the system also usually generates a number of random values to try out. This makes things a bit non-deterministic -- each run will be tried with somewhat different data. To make it easier to debug, and to build regression tests, the system provides tools to re-run a failed test with precisely the same data.

    Background

    TODO: Bill should insert a brief section on QuickCheck, ScalaCheck, etc, and how this system is similar and different.

    Using Property Checks

    In order to use the tools described here, you should import this package:

    import org.scalatest._
import org.scalatest.prop._

    This library is designed to work well with the types defined in Scalactic, and some functions take types such as PosZInt as parameters. So it can also be helpful to import those with:

    import org.scalactic.anyvals._

    In order to call forAll, the function that actually performs property checks, you will need to either extend or import GeneratorDrivenPropertyChecks, like this:

    class DocExamples extends FlatSpec with Matchers with GeneratorDrivenPropertyChecks {

    There's nothing special about FlatSpec, though -- you may use any of ScalaTest's styles with property checks. GeneratorDrivenPropertyChecks extends CommonGenerators, so it also provides access to the many utilities found there.

    What Does a Property Look Like?

    Let's check a simple property of Strings -- that if you concatenate a String to itself, its length will be doubled:

    "Strings" should "have the correct length when doubled" in {
  forAll { (s: String) =>
    val s2 = s * 2
    s2.length should equal (s.length * 2)
  }
}

    (Note that the examples here are all using the FlatSpec style, but will work the same way with any of ScalaTest's styles.)

    As the name of the tests suggests, the property we are testing is the length of a String that has been doubled.

    The test begins with forAll. This is usually the way you'll want to begin property checks, and that line can be read as, "For all Strings, the following should be true".

    The test harness will generate a number of Strings, with various contents and lengths. For each one, we compute s * 2. (* is a function on String, which appends the String to itself as many times as you specify.) And then we check that the length of the doubled String is twice the length of the original one.

    Using Specific Generators

    Let's try a more general version of this test, multiplying arbitrary Strings by arbitrary multipliers:

    "Strings" should "have the correct length when multiplied" in {
  forAll { (s: String, n: PosZInt) =>
    val s2 = s * n.value
    s2.length should equal (s.length * n.value)
  }
}

    Again, you can read the first line of the test as "For all Strings, and all non-negative Integers, the following should be true". (PosZInt is a type defined in Scalactic, which can be any positive integer, including zero. It is appropriate to use here, since multiplying a String by a negative number doesn't make sense.)

    This intuitively makes sense, but when we try to run it, we get a JVM Out of Memory error! Why? Because the test system tries to test with the "edge cases" first, and one of the more important edge cases is Int.MaxValue. It is trying to multiply a String by that, which is far larger than the memory of even a big computer, and crashing.

    So we want to constrain our test to sane values of n, so that it doesn't crash. We can do this by using more specific Generators.

    When we write a forAll test like the above, ScalaTest has to generate the values to be tested -- the semi-random Strings, Ints and other types that you are testing. It does this by calling on an implicit Generator for the desired type. The Generator generates values to test, starting with the edge cases and then moving on to randomly-selected values.

    ScalaTest has built-in Generators for many major types, including String and PosZInt, but these Generators are generic: they will try any value, including values that can break your test, as shown above. But it also provides tools to let you be more specific.

    Here is the fixed version of the above test:

    "Strings" should "have the correct length when multiplied" in {
  forAll(strings, posZIntsBetween(0, 1000))
  { (s: String, n: PosZInt) =>
    val s2 = s * n.value
    s2.length should equal (s.length * n.value)
  }
}

    This is using a variant of forAll, which lets you specify the Generators to use instead of just picking the implicit one. CommonGenerators.strings is the built-in Generator for Strings, the same one you were getting implicitly. (The other built-ins can be found in CommonGenerators. They are mixed into GeneratorDrivenPropertyChecks, so they are readily available.)

    But CommonGenerators.posZIntsBetween is a function that creates a Generator that selects from the given values. In this case, it will create a Generator that only creates numbers from 0 to 1000 -- small enough to not blow up our computer's memory. If you try this test, this runs correctly.

    The moral of the story is that, while using the built-in Generators is very convenient, and works most of the time, you should think about the data you are trying to test, and pick or create a more-specific Generator when the test calls for it.

    CommonGenerators contains many functions that are helpful in common cases. In particular:

    • xxsBetween (where xxs might be Int, Long, Float or most other significant numeric types) gives you a value of the desired type in the given range, as in the posZIntsBetween() example above.
    • CommonGenerators.specificValue and CommonGenerators.specificValues create Generators that produce either one specific value every time, or one of several values randomly. This is useful for enumerations and types that behave like enumerations.
    • CommonGenerators.evenly and CommonGenerators.frequency create higher-level Generators that call other Generators, either more or less equally or with a distribution you define.

    Testing Your Own Types

    Testing the built-in types isn't very interesting, though. Usually, you have your own types that you want to check the properties of. So let's build up an example piece by piece.

    Say you have this simple type:

    sealed trait Shape {
  def area: Double
}
case class Rectangle(width: Int, height: Int) extends Shape {
  require(width > 0)
  require(height > 0)
  def area: Double = width * height
}

    Let's confirm a nice straightforward property that is surely true: that the area is greater than zero:

    "Rectangles" should "have a positive area" in {
   forAll { (w: PosInt, h: PosInt) =>
     val rect = Rectangle(w, h)
     rect.area should be > 0.0
   }
 }

    Note that, even though our class takes ordinary Ints as parameters (and checks the values at runtime), it is actually easier to generate the legal values using Scalactic's PosInt type.

    This should work, right? Actually, it doesn't -- if we run it a few times, we quickly hit an error!

    [info] Rectangles
[info] - should have a positive area *** FAILED ***
[info]   GeneratorDrivenPropertyCheckFailedException was thrown during property evaluation.
[info]    (DocExamples.scala:42)
[info]     Falsified after 2 successful property evaluations.
[info]     Location: (DocExamples.scala:42)
[info]     Occurred when passed generated values (
[info]       None = PosInt(399455539),
[info]       None = PosInt(703518968)
[info]     )
[info]     Init Seed: 1568878346200

    TODO: fix the above error to reflect the better errors we should get when we merge in the code being forward-ported from 3.0.5.

    Looking at it, we can see that the numbers being used are pretty large. What happens when we multiply them together?

    scala> 399455539 * 703518968
res0: Int = -2046258840

    We're hitting an Int overflow problem here: the numbers are too big to multiply together and still get an Int. So we have to fix our area function:

    case class Rectangle(width: Int, height: Int) extends Shape {
  require(width > 0)
  require(height > 0)
  def area: Double = width.toLong * height.toLong
}

    Now, when we run our property check, it consistently passes. Excellent -- we've caught a bug, because ScalaTest tried sufficiently large numbers.

    Composing Your Own Generators

    Doing things as shown above works, but having to generate the parameters and construct a Rectangle every time is a nuisance. What we really want is to create our own Generator that just hands us Rectangles, the same way we can do for PosInt. Fortunately, this is easy.

    Generators can be composed in for comprehensions. So we can create our own Generator for Rectangle like this:

    implicit val rectGenerator = for {
  w <- posInts
  h <- posInts
}
  yield Rectangle(w, h)

    Taking that line by line:

    w <- posInts

    CommonGenerators.posInts is the built-in Generator for positive Ints. So this line puts a randomly-generated positive Int in w, and

    h <- posInts

    this line puts another one in h. Finally, this line:

    yield Rectangle(w, h)

    combines w and h to make a Rectangle.

    That's pretty much all you need in order to build any normal case class -- just build it out of the Generators for the type of each field. (And if the fields are complex data structures themselves, build Generators for them the same way, until you are just using primitives.)

    Now, our property check becomes simpler:

    "Generated Rectangles" should "have a positive area" in {
   forAll { (rect: Rectangle) =>
     rect.area should be > 0.0
   }
 }

    That's about as close to plain English as we can reasonably hope for!

    Filtering Values with whenever()

    Sometimes, not all of your generated values make sense for the property you want to check -- you know (via external information) that some of these values will never come up. In cases like this, you can create a custom Generator that only creates the values you do want, but it's often easier to just use Whenever.whenever. (Whenever is mixed into GeneratorDrivenPropertyChecks, so this is available when you need it.)

    The Whenever.whenever function can be used inside of GeneratorDrivenPropertyChecks.forAll. It says that only the filtered values should be used, and anything else should be discarded. For example, look at this property:

    "Fractions" should "get smaller when squared" in {
  forAll { (n: Float) =>
    whenever(n > 0 && n < 1) {
      (n * n) should be < n
    }
  }
}

    We are testing a property of numbers less than 1, so we filter away everything that is not the numbers we want. This property check succeeds, because we've screened out the values that would make it fail.

    Discard Limits

    You shouldn't push Whenever.whenever too far, though. This system is all about trying random data, but if too much of the random data simply isn't usable, you can't get valid answers, and the system tracks that.

    For example, consider this apparently-reasonable test:

    "Space Chars" should "not also be letters" in {
  forAll { (c: Char) =>
    whenever (c.isSpaceChar) {
      assert(!c.isLetter)
    }
  }
}

    Although the property is true, this test will fail with an error like this:

    [info] Lowercase Chars
[info] - should upper-case correctly *** FAILED ***
[info]   Gave up after 0 successful property evaluations. 49 evaluations were discarded.
[info]   Init Seed: 1568855247784

    Because the vast majority of Chars are not spaces, nearly all of the generated values are being discarded. As a result, the system gives up after a while. In cases like this, you usually should write a custom Generator instead.

    The proportion of how many discards to permit, relative to the number of successful checks, is configuration-controllable. See GeneratorDrivenPropertyChecks for more details.

    Randomization

    The point of Generator is to create pseudo-random values for checking properties. But it turns out to be very inconvenient if those values are actually random -- that would mean that, when a property check fails occasionally, you have no good way to invoke that specific set of circumstances again for debugging. We want "randomness", but we also want it to be deterministic, and reproducible when you need it.

    To support this, all "randomness" in ScalaTest's property checking system uses the Randomizer class. You start by creating a Randomizer using an initial seed value, and call that to get your "random" value. Each call to a Randomizer function returns a new Randomizer, which you should use to fetch the next value.

    GeneratorDrivenPropertyChecks.forAll uses Randomizer under the hood: each time you run a forAll-based test, it will automatically create a new Randomizer, which by default is seeded based on the current system time. You can override this, as discussed below.

    Since Randomizer is actually deterministic (the "random" values are unobvious, but will always be the same given the same initial seed), this means that re-running a test with the same seed will produce the same values.

    If you need random data for your own Generators and property checks, you should use Randomizer in the same way; that way, your tests will also be re-runnable, when needed for debugging.

    Debugging, and Re-running a Failed Property Check

    In Testing Your Own Types above, we found to our surprise that the property check failed with this error:

    [info] Rectangles
[info] - should have a positive area *** FAILED ***
[info]   GeneratorDrivenPropertyCheckFailedException was thrown during property evaluation.
[info]    (DocExamples.scala:42)
[info]     Falsified after 2 successful property evaluations.
[info]     Location: (DocExamples.scala:42)
[info]     Occurred when passed generated values (
[info]       None = PosInt(399455539),
[info]       None = PosInt(703518968)
[info]     )
[info]     Init Seed: 1568878346200

    There must be a bug here -- but once we've fixed it, how can we make sure that we are re-testing exactly the same case that failed?

    This is where the pseudo-random nature of Randomizer comes in, and why it is so important to use it consistently. So long as all of our "random" data comes from that, then all we need to do is re-run with the same seed.

    That's why the Init Seed shown in the message above is crucial. We can re-use that seed -- and therefore get exactly the same "random" data -- by using the -S flag to ScalaTest.

    So you can run this command in sbt to re-run exactly the same property check:

    testOnly *DocExamples -- -z "have a positive area" -S 1568878346200

    Taking that apart:

    • testOnly *DocExamples says that we only want to run suites whose paths end with DocExamples
    • -z "have a positive area" says to only run tests whose names include that string.
    • -S 1568878346200 says to run all tests with a "random" seed of 1568878346200

    By combining these flags, you can re-run exactly the property check you need, with the right random seed to make sure you are re-creating the failed test. You should get exactly the same failure over and over until you fix the bug, and then you can confirm your fix with confidence.

    Configuration

    In general, forAll() works well out of the box. But you can tune several configuration parameters when needed. See GeneratorDrivenPropertyChecks for info on how to set configuration parameters for your test.

    Table-Driven Properties

    Sometimes, you want something in between traditional hard-coded unit tests and Generator-driven, randomized tests. Instead, you sometimes want to check your properties against a specific set of inputs.

    (This is particularly useful for regression tests, when you have found certain inputs that have caused problems in the past, and want to make sure that they get consistently re-tested.)

    ScalaTest supports these, by mixing in TableDrivenPropertyChecks. See the documentation for that class for the full details.

    Definition Classes
    scalatest
  • package tagobjects
    Definition Classes
    scalatest
  • package time
    Definition Classes
    scalatest
  • package tools
    Definition Classes
    scalatest
  • package words
    Definition Classes
    scalatest
  • Alerter
  • Alerting
  • AppendedClues
  • Args
  • Assertions
  • AsyncFeatureSpec
  • AsyncFlatSpec
  • AsyncFreeSpec
  • AsyncFunSpec
  • AsyncFunSuite
  • AsyncTestRegistration
  • AsyncTestSuite
  • AsyncTestSuiteMixin
  • AsyncWordSpec
  • AsyncWordSpecLike
  • BeforeAndAfter
  • BeforeAndAfterAll
  • BeforeAndAfterAllConfigMap
  • BeforeAndAfterEach
  • BeforeAndAfterEachTestData
  • CancelAfterFailure
  • Canceled
  • Checkpoints
  • CompleteLastly
  • CompositeStatus
  • ConfigMap
  • DiagrammedAssertions
  • DiagrammedExpr
  • DistributedSuiteSorter
  • DistributedTestSorter
  • Distributor
  • DoNotDiscover
  • Documenter
  • Documenting
  • DynaTags
  • EitherValues
  • Entry
  • Exceptional
  • Expectations
  • Failed
  • FailedStatus
  • FeatureSpec
  • Filter
  • Finders
  • FixtureContext
  • FlatSpec
  • FreeSpec
  • FunSpec
  • FunSuite
  • FutureOutcome
  • GivenWhenThen
  • Ignore
  • Informer
  • Informing
  • Inside
  • Inspectors
  • LoneElement
  • Matchers
  • MustMatchers
  • NonImplicitAssertions
  • Notifier
  • Notifying
  • OneInstancePerTest
  • OptionValues
  • Outcome
  • OutcomeOf
  • ParallelTestExecution
  • PartialFunctionValues
  • Payloads
  • Pending
  • PendingStatement
  • PrivateMethodTester
  • PropSpec
  • PropSpecLike
  • RandomTestOrder
  • RecoverMethods
  • Reporter
  • Rerunner
  • ResourcefulReporter
  • Retries
  • Sequential
  • SequentialNestedSuiteExecution
  • StatefulStatus
  • Status
  • Stepwise
  • StepwiseNestedSuiteExecution
  • Stopper
  • Succeeded
  • SucceededStatus
  • Suite
  • SuiteMixin
  • Suites
  • Tag
  • TagAnnotation
  • TestData
  • TestRegistration
  • TestSuite
  • TestSuiteMixin
  • TestsBeforeNestedSuites
  • Tracker
  • TryValues
  • WordSpec
  • WordSpecLike
  • WrapWith

class ConfigMap extends Map[String, Any] with MapLike[String, Any, ConfigMap] with Serializable

A map of configuration data.

A ConfigMap can be populated from the Runner command line via -D arguments. Runner passes it to many methods where you can use it to configure your test runs. For example, Runner passed the ConfigMap to:

  • the apply method of Reporters via RunStarting events
  • the run method of Suite
  • the runNestedSuites method of Suite
  • the runTests method of Suite
  • the runTest method of Suite
  • the withFixture(NoArgTest) method of Suite
  • the withFixture(OneArgTest) method of fixture.Suite
  • the beforeEach(TestData) method of BeforeAndAfterEachTestData
  • the afterEach(TestData) method of BeforeAndAfterEachTestData

In addition to accessing the ConfigMap in overriden implementations of the above methods, you can also transform and pass along a modified ConfigMap.

A ConfigMap maps string keys to values of any type, i.e., it is a Map[String, Any]. To get a configuration value in a variable of the actual type of that value, therefore, you'll need to perform an unsafe cast. If this cast fails, you'll get an exception, which so long as the ConfigMap is used only in tests, will result in either a failed or canceled test or aborted suite. To give such exceptions nice stack depths and error messages, and to eliminate the need for using asInstanceOf in your test code, ConfigMap provides three methods for accessing values at expected types.

The getRequired method returns the value bound to a key cast to a specified type, or throws TestCanceledException if either the key is not bound or is bound to an incompatible type. Here's an example:

val tempFileName: String = configMap.getRequired[String]("tempFileName")

The getOptional method returns the value bound to a key cast to a specified type, wrapped in a Some, returns None if the key is not bound, or throws TestCanceledException if the key exists but is bound to an incompatible type. Here's an example:

val tempFileName: Option[String] = configMap.getOptional[String]("tempFileName")

The getWithDefault method returns the value bound to a key cast to a specified type, returns a specified default value if the key is not bound, or throws TestCanceledException if the key exists but is either not bound or is bound to an incompatible type. Here's an example:

val tempFileName: String = configMap.getWithDefault[String]("tempFileName", "tmp.txt")

Source
ConfigMap.scala
Linear Supertypes
Serializable, Map[String, Any], MapLike[String, Any, ConfigMap], Map[String, Any], MapLike[String, Any, ConfigMap], Subtractable[String, ConfigMap], PartialFunction[String, Any], (String) ⇒ Any, GenMap[String, Any], GenMapLike[String, Any, ConfigMap], Iterable[(String, Any)], Iterable[(String, Any)], IterableLike[(String, Any), ConfigMap], Equals, GenIterable[(String, Any)], GenIterableLike[(String, Any), ConfigMap], Traversable[(String, Any)], Immutable, Traversable[(String, Any)], GenTraversable[(String, Any)], GenericTraversableTemplate[(String, Any), Iterable], TraversableLike[(String, Any), ConfigMap], GenTraversableLike[(String, Any), ConfigMap], Parallelizable[(String, Any), ParMap[String, Any]], TraversableOnce[(String, Any)], GenTraversableOnce[(String, Any)], FilterMonadic[(String, Any), ConfigMap], HasNewBuilder[(String, Any), ConfigMap], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigMap
  2. Serializable
  3. Map
  4. MapLike
  5. Map
  6. MapLike
  7. Subtractable
  8. PartialFunction
  9. Function1
  10. GenMap
  11. GenMapLike
  12. Iterable
  13. Iterable
  14. IterableLike
  15. Equals
  16. GenIterable
  17. GenIterableLike
  18. Traversable
  19. Immutable
  20. Traversable
  21. GenTraversable
  22. GenericTraversableTemplate
  23. TraversableLike
  24. GenTraversableLike
  25. Parallelizable
  26. TraversableOnce
  27. GenTraversableOnce
  28. FilterMonadic
  29. HasNewBuilder
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConfigMap(underlying: Map[String, Any])

    underlying

    an immutable Map that holds the key/value pairs contained in this ConfigMap

Type Members

  1. class DefaultKeySet extends AbstractSet[K] with Set[K] with Serializable
    Attributes
    protected
    Definition Classes
    MapLike
  2. class DefaultValuesIterable extends AbstractIterable[V] with Iterable[V] with Serializable
    Attributes
    protected
    Definition Classes
    MapLike
  3. class FilteredKeys extends AbstractMap[K, V] with DefaultMap[K, V]
    Attributes
    protected
    Definition Classes
    MapLike
  4. class ImmutableDefaultKeySet extends scala.collection.immutable.MapLike.DefaultKeySet with Set[K]
    Attributes
    protected
    Definition Classes
    MapLike
  5. class MappedValues[W] extends AbstractMap[K, W] with DefaultMap[K, W]
    Attributes
    protected
    Definition Classes
    MapLike
  6. type Self = ConfigMap
    Attributes
    protected[this]
    Definition Classes
    TraversableLike
  7. class WithFilter extends FilterMonadic[A, Repr]
    Definition Classes
    TraversableLike

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +[A >: Any](kv: (String, A)): ConfigMap
    Definition Classes
    ConfigMap → Map → MapLike → MapLike → GenMapLike
  4. def +[V1 >: Any](elem1: (String, V1), elem2: (String, V1), elems: (String, V1)*): Map[String, V1]
    Definition Classes
    MapLike → MapLike
  5. def ++[V1 >: Any](xs: GenTraversableOnce[(String, V1)]): Map[String, V1]
    Definition Classes
    MapLike → MapLike
  6. def ++[B >: (String, Any), That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  7. def ++:[B >: (String, Any), That](that: Traversable[B])(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike
  8. def ++:[B >: (String, Any), That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike
  9. def -(key: String): ConfigMap
    Definition Classes
    ConfigMap → MapLike → Subtractable → GenMapLike
  10. def -(elem1: String, elem2: String, elems: String*): ConfigMap
    Definition Classes
    Subtractable
  11. def --(xs: GenTraversableOnce[String]): ConfigMap
    Definition Classes
    Subtractable
  12. def /:[B](z: B)(op: (B, (String, Any)) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  13. def :\[B](z: B)(op: ((String, Any), B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  14. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
    Definition Classes
    MapLike → TraversableOnce
  16. def addString(b: StringBuilder): StringBuilder
    Definition Classes
    TraversableOnce
  17. def addString(b: StringBuilder, sep: String): StringBuilder
    Definition Classes
    TraversableOnce
  18. def aggregate[B](z: ⇒ B)(seqop: (B, (String, Any)) ⇒ B, combop: (B, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  19. def andThen[C](k: (Any) ⇒ C): PartialFunction[String, C]
    Definition Classes
    PartialFunction → Function1
  20. def apply(key: String): Any
    Definition Classes
    MapLike → GenMapLike → Function1
  21. def applyOrElse[K1 <: String, V1 >: Any](x: K1, default: (K1) ⇒ V1): V1
    Definition Classes
    MapLike → PartialFunction
  22. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  23. def canEqual(that: Any): Boolean
    Definition Classes
    IterableLike → Equals
  24. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  25. def collect[B, That](pf: PartialFunction[(String, Any), B])(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  26. def collectFirst[B](pf: PartialFunction[(String, Any), B]): Option[B]
    Definition Classes
    TraversableOnce
  27. def companion: GenericCompanion[Iterable]
    Definition Classes
    Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → GenericTraversableTemplate
  28. def compose[A](g: (A) ⇒ String): (A) ⇒ Any
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  29. def contains(key: String): Boolean
    Definition Classes
    MapLike → GenMapLike
  30. def copyToArray[B >: (String, Any)](xs: Array[B], start: Int, len: Int): Unit
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  31. def copyToArray[B >: (String, Any)](xs: Array[B]): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  32. def copyToArray[B >: (String, Any)](xs: Array[B], start: Int): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  33. def copyToBuffer[B >: (String, Any)](dest: Buffer[B]): Unit
    Definition Classes
    TraversableOnce
  34. def count(p: ((String, Any)) ⇒ Boolean): Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  35. def default(key: String): Any
    Definition Classes
    MapLike → GenMapLike
  36. def drop(n: Int): ConfigMap
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  37. def dropRight(n: Int): ConfigMap
    Definition Classes
    IterableLike
  38. def dropWhile(p: ((String, Any)) ⇒ Boolean): ConfigMap
    Definition Classes
    TraversableLike → GenTraversableLike
  39. def empty: ConfigMap
    Definition Classes
    ConfigMap → Map → Map → MapLike
  40. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def equals(that: Any): Boolean
    Definition Classes
    GenMapLike → Equals → AnyRef → Any
  42. def exists(p: ((String, Any)) ⇒ Boolean): Boolean
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  43. def filter(p: ((String, Any)) ⇒ Boolean): ConfigMap
    Definition Classes
    TraversableLike → GenTraversableLike
  44. def filterKeys(p: (String) ⇒ Boolean): Map[String, Any]
    Definition Classes
    MapLike → MapLike → GenMapLike
  45. def filterNot(p: ((String, Any)) ⇒ Boolean): ConfigMap
    Definition Classes
    MapLike → TraversableLike → GenTraversableLike
  46. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  47. def find(p: ((String, Any)) ⇒ Boolean): Option[(String, Any)]
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  48. def flatMap[B, That](f: ((String, Any)) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic
  49. def flatten[B](implicit asTraversable: ((String, Any)) ⇒ GenTraversableOnce[B]): Iterable[B]
    Definition Classes
    GenericTraversableTemplate
  50. def fold[A1 >: (String, Any)](z: A1)(op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  51. def foldLeft[B](z: B)(op: (B, (String, Any)) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  52. def foldRight[B](z: B)(op: ((String, Any), B) ⇒ B): B
    Definition Classes
    IterableLike → TraversableOnce → GenTraversableOnce
  53. def forall(p: ((String, Any)) ⇒ Boolean): Boolean
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  54. def foreach[U](f: ((String, Any)) ⇒ U): Unit
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
  55. def genericBuilder[B]: Builder[B, Iterable[B]]
    Definition Classes
    GenericTraversableTemplate
  56. def get(key: String): Option[Any]
    Definition Classes
    ConfigMap → MapLike → GenMapLike
  57. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. def getOptional[V](key: String)(implicit classTag: ClassTag[V]): Option[V]

    Returns the value bound to a key cast to a specified type, wrapped in a Some, returns None if the key is not bound, or throws TestCanceledException if the key exists but is bound to an incompatible type.

    Returns the value bound to a key cast to a specified type, wrapped in a Some, returns None if the key is not bound, or throws TestCanceledException if the key exists but is bound to an incompatible type. Here's an example:

    val tempFileName: Option[String] = configMap.getOptional[String]("tempFileName")

    key

    the key with which the desired value should be associated

    classTag

    an implicit ClassTag specifying the expected type for the desired value

  59. def getOrElse[V1 >: Any](key: String, default: ⇒ V1): V1
    Definition Classes
    MapLike → GenMapLike
  60. def getRequired[V](key: String)(implicit classTag: ClassTag[V], pos: Position): V

    Returns the value bound to a key cast to the specified type V, or throws TestCanceledException if either the key is not bound or is bound to an incompatible type.

    Returns the value bound to a key cast to the specified type V, or throws TestCanceledException if either the key is not bound or is bound to an incompatible type. Here's an example:

    val tempFileName: String = configMap.getRequired[String]("tempFileName")

    key

    the key with which the desired value should be associated

    classTag

    an implicit ClassTag specifying the expected type for the desired value

  61. def getWithDefault[V](key: String, default: ⇒ V)(implicit classTag: ClassTag[V]): V

    Returns the value bound to a key cast to the specified type V, returns a specified default value if the key is not bound, or throws TestCanceledException if the key exists but is if either the key is not bound or is bound to an incompatible type.

    Returns the value bound to a key cast to the specified type V, returns a specified default value if the key is not bound, or throws TestCanceledException if the key exists but is if either the key is not bound or is bound to an incompatible type. Here's an example:

    val tempFileName: String = configMap.getWithDefault[String]("tempFileName", "tmp.txt")

    key

    the key with which the desired value should be associated

    default

    a default value to return if the key is not found

    classTag

    an implicit ClassTag specifying the expected type for the desired value

  62. def groupBy[K](f: ((String, Any)) ⇒ K): Map[K, ConfigMap]
    Definition Classes
    TraversableLike → GenTraversableLike
  63. def grouped(size: Int): Iterator[ConfigMap]
    Definition Classes
    IterableLike
  64. def hasDefiniteSize: Boolean
    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce
  65. def hashCode(): Int
    Definition Classes
    GenMapLike → AnyRef → Any
  66. def head: (String, Any)
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  67. def headOption: Option[(String, Any)]
    Definition Classes
    TraversableLike → GenTraversableLike
  68. def init: ConfigMap
    Definition Classes
    TraversableLike → GenTraversableLike
  69. def inits: Iterator[ConfigMap]
    Definition Classes
    TraversableLike
  70. def isDefinedAt(key: String): Boolean
    Definition Classes
    MapLike → GenMapLike → PartialFunction
  71. def isEmpty: Boolean
    Definition Classes
    MapLike → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. final def isTraversableAgain: Boolean
    Definition Classes
    TraversableLike → GenTraversableLike → GenTraversableOnce
  74. def iterator: Iterator[(String, Any)]
    Definition Classes
    ConfigMap → MapLike → IterableLike → GenIterableLike
  75. def keySet: Set[String]
    Definition Classes
    MapLike → MapLike → GenMapLike
  76. def keys: Iterable[String]
    Definition Classes
    MapLike → GenMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) keys returns Iterable[K] rather than Iterator[K].

  77. def keysIterator: Iterator[String]
    Definition Classes
    MapLike → GenMapLike
  78. def last: (String, Any)
    Definition Classes
    TraversableLike → GenTraversableLike
  79. def lastOption: Option[(String, Any)]
    Definition Classes
    TraversableLike → GenTraversableLike
  80. def lift: (String) ⇒ Option[Any]
    Definition Classes
    PartialFunction
  81. def map[B, That](f: ((String, Any)) ⇒ B)(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic
  82. def mapValues[W](f: (Any) ⇒ W): Map[String, W]
    Definition Classes
    MapLike → MapLike → GenMapLike
  83. def max[B >: (String, Any)](implicit cmp: Ordering[B]): (String, Any)
    Definition Classes
    TraversableOnce → GenTraversableOnce
  84. def maxBy[B](f: ((String, Any)) ⇒ B)(implicit cmp: Ordering[B]): (String, Any)
    Definition Classes
    TraversableOnce → GenTraversableOnce
  85. def min[B >: (String, Any)](implicit cmp: Ordering[B]): (String, Any)
    Definition Classes
    TraversableOnce → GenTraversableOnce
  86. def minBy[B](f: ((String, Any)) ⇒ B)(implicit cmp: Ordering[B]): (String, Any)
    Definition Classes
    TraversableOnce → GenTraversableOnce
  87. def mkString: String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  88. def mkString(sep: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  89. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  90. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  91. def newBuilder: Builder[(String, Any), ConfigMap]
    Attributes
    protected[this]
    Definition Classes
    MapLike → TraversableLike → HasNewBuilder
  92. def nonEmpty: Boolean
    Definition Classes
    TraversableOnce → GenTraversableOnce
  93. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  94. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  95. def orElse[A1 <: String, B1 >: Any](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]
    Definition Classes
    PartialFunction
  96. def par: ParMap[String, Any]
    Definition Classes
    Parallelizable
  97. def parCombiner: Combiner[(String, Any), ParMap[String, Any]]
    Attributes
    protected[this]
    Definition Classes
    MapLike → MapLike → TraversableLike → Parallelizable
  98. def partition(p: ((String, Any)) ⇒ Boolean): (ConfigMap, ConfigMap)
    Definition Classes
    TraversableLike → GenTraversableLike
  99. def product[B >: (String, Any)](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  100. def reduce[A1 >: (String, Any)](op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  101. def reduceLeft[B >: (String, Any)](op: (B, (String, Any)) ⇒ B): B
    Definition Classes
    TraversableOnce
  102. def reduceLeftOption[B >: (String, Any)](op: (B, (String, Any)) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  103. def reduceOption[A1 >: (String, Any)](op: (A1, A1) ⇒ A1): Option[A1]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  104. def reduceRight[B >: (String, Any)](op: ((String, Any), B) ⇒ B): B
    Definition Classes
    IterableLike → TraversableOnce → GenTraversableOnce
  105. def reduceRightOption[B >: (String, Any)](op: ((String, Any), B) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  106. def repr: ConfigMap
    Definition Classes
    TraversableLike → GenTraversableLike
  107. def reversed: List[(String, Any)]
    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  108. def runWith[U](action: (Any) ⇒ U): (String) ⇒ Boolean
    Definition Classes
    PartialFunction
  109. def sameElements[B >: (String, Any)](that: GenIterable[B]): Boolean
    Definition Classes
    IterableLike → GenIterableLike
  110. def scan[B >: (String, Any), That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  111. def scanLeft[B, That](z: B)(op: (B, (String, Any)) ⇒ B)(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  112. def scanRight[B, That](z: B)(op: ((String, Any), B) ⇒ B)(implicit bf: CanBuildFrom[ConfigMap, B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.

  113. def seq: Map[String, Any]
    Definition Classes
    Map → Map → GenMap → GenMapLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
  114. def size: Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  115. def sizeHintIfCheap: Int
    Attributes
    protected[scala.collection]
    Definition Classes
    GenTraversableOnce
  116. def slice(from: Int, until: Int): ConfigMap
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  117. def sliding(size: Int, step: Int): Iterator[ConfigMap]
    Definition Classes
    IterableLike
  118. def sliding(size: Int): Iterator[ConfigMap]
    Definition Classes
    IterableLike
  119. def span(p: ((String, Any)) ⇒ Boolean): (ConfigMap, ConfigMap)
    Definition Classes
    TraversableLike → GenTraversableLike
  120. def splitAt(n: Int): (ConfigMap, ConfigMap)
    Definition Classes
    TraversableLike → GenTraversableLike
  121. def stringPrefix: String
    Definition Classes
    MapLike → TraversableLike → GenTraversableLike
  122. def sum[B >: (String, Any)](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  123. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  124. def tail: ConfigMap
    Definition Classes
    TraversableLike → GenTraversableLike
  125. def tails: Iterator[ConfigMap]
    Definition Classes
    TraversableLike
  126. def take(n: Int): ConfigMap
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  127. def takeRight(n: Int): ConfigMap
    Definition Classes
    IterableLike
  128. def takeWhile(p: ((String, Any)) ⇒ Boolean): ConfigMap
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  129. def thisCollection: Iterable[(String, Any)]
    Attributes
    protected[this]
    Definition Classes
    IterableLike → TraversableLike
  130. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, (String, Any), Col[(String, Any)]]): Col[(String, Any)]
    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce
  131. def toArray[B >: (String, Any)](implicit arg0: ClassTag[B]): Array[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  132. def toBuffer[E >: (String, Any)]: Buffer[E]
    Definition Classes
    MapLike → TraversableOnce → GenTraversableOnce
  133. def toCollection(repr: ConfigMap): Iterable[(String, Any)]
    Attributes
    protected[this]
    Definition Classes
    IterableLike → TraversableLike
  134. def toIndexedSeq: IndexedSeq[(String, Any)]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  135. def toIterable: Iterable[(String, Any)]
    Definition Classes
    IterableLike → TraversableOnce → GenTraversableOnce
  136. def toIterator: Iterator[(String, Any)]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableOnce
    Annotations
    @deprecatedOverriding( ... , "2.11.0" )
  137. def toList: List[(String, Any)]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  138. def toMap[T, U](implicit ev: <:<[(String, Any), (T, U)]): Map[T, U]
    Definition Classes
    Map → TraversableOnce → GenTraversableOnce
    Annotations
    @deprecatedOverriding( ... , "2.11.0" )
  139. def toSeq: Seq[(String, Any)]
    Definition Classes
    MapLike → TraversableOnce → GenTraversableOnce
  140. def toSet[B >: (String, Any)]: Set[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  141. def toStream: Stream[(String, Any)]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableOnce
  142. def toString(): String
    Definition Classes
    MapLike → TraversableLike → Function1 → AnyRef → Any
  143. def toTraversable: Traversable[(String, Any)]
    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce
    Annotations
    @deprecatedOverriding( ... , "2.11.0" )
  144. def toVector: Vector[(String, Any)]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  145. def transform[W, That](f: (String, Any) ⇒ W)(implicit bf: CanBuildFrom[ConfigMap, (String, W), That]): That
    Definition Classes
    MapLike
  146. def transpose[B](implicit asTraversable: ((String, Any)) ⇒ GenTraversableOnce[B]): Iterable[Iterable[B]]
    Definition Classes
    GenericTraversableTemplate
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.

  147. def unzip[A1, A2](implicit asPair: ((String, Any)) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])
    Definition Classes
    GenericTraversableTemplate
  148. def unzip3[A1, A2, A3](implicit asTriple: ((String, Any)) ⇒ (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
    Definition Classes
    GenericTraversableTemplate
  149. def updated[V1 >: Any](key: String, value: V1): Map[String, V1]
    Definition Classes
    MapLike → MapLike
  150. def values: Iterable[Any]
    Definition Classes
    MapLike → GenMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) values returns Iterable[V] rather than Iterator[V].

  151. def valuesIterator: Iterator[Any]
    Definition Classes
    MapLike → GenMapLike
  152. def view(from: Int, until: Int): IterableView[(String, Any), ConfigMap]
    Definition Classes
    IterableLike → TraversableLike
  153. def view: IterableView[(String, Any), ConfigMap]
    Definition Classes
    IterableLike → TraversableLike
  154. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  155. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  156. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  157. def withDefault[V1 >: Any](d: (String) ⇒ V1): Map[String, V1]
    Definition Classes
    Map
  158. def withDefaultValue[V1 >: Any](d: V1): Map[String, V1]
    Definition Classes
    Map
  159. def withFilter(p: ((String, Any)) ⇒ Boolean): FilterMonadic[(String, Any), ConfigMap]
    Definition Classes
    TraversableLike → FilterMonadic
  160. def zip[A1 >: (String, Any), B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[ConfigMap, (A1, B), That]): That
    Definition Classes
    IterableLike → GenIterableLike
  161. def zipAll[B, A1 >: (String, Any), That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[ConfigMap, (A1, B), That]): That
    Definition Classes
    IterableLike → GenIterableLike
  162. def zipWithIndex[A1 >: (String, Any), That](implicit bf: CanBuildFrom[ConfigMap, (A1, Int), That]): That
    Definition Classes
    IterableLike → GenIterableLike

Inherited from Serializable

Inherited from Map[String, Any]

Inherited from MapLike[String, Any, ConfigMap]

Inherited from Map[String, Any]

Inherited from MapLike[String, Any, ConfigMap]

Inherited from Subtractable[String, ConfigMap]

Inherited from PartialFunction[String, Any]

Inherited from (String) ⇒ Any

Inherited from GenMap[String, Any]

Inherited from GenMapLike[String, Any, ConfigMap]

Inherited from Iterable[(String, Any)]

Inherited from Iterable[(String, Any)]

Inherited from IterableLike[(String, Any), ConfigMap]

Inherited from Equals

Inherited from GenIterable[(String, Any)]

Inherited from GenIterableLike[(String, Any), ConfigMap]

Inherited from Traversable[(String, Any)]

Inherited from Immutable

Inherited from Traversable[(String, Any)]

Inherited from GenTraversable[(String, Any)]

Inherited from GenericTraversableTemplate[(String, Any), Iterable]

Inherited from TraversableLike[(String, Any), ConfigMap]

Inherited from GenTraversableLike[(String, Any), ConfigMap]

Inherited from Parallelizable[(String, Any), ParMap[String, Any]]

Inherited from TraversableOnce[(String, Any)]

Inherited from GenTraversableOnce[(String, Any)]

Inherited from FilterMonadic[(String, Any), ConfigMap]

Inherited from HasNewBuilder[(String, Any), ConfigMap]

Inherited from AnyRef

Inherited from Any

Ungrouped