Aggregating

Typeclass that enables for aggregations certain contain syntax in the ScalaTest matchers DSL.

An Aggregating[A] provides access to the "aggregating nature" of type A in such a way that relevant contain matcher syntax can be used with type A. An A can be any type of aggregation—an object that in some way aggregates or brings together other objects. ScalaTest provides implicit implementations for several types out of the box in the Aggregating companion object:

scala.collection.GenTraversable
String
Array
java.util.Collection
java.util.Map

The contain syntax enabled by this trait is:

result should contain atLeastOneOf (1, 2, 3)
result should contain atMostOneOf (1, 2, 3)
result should contain only (1, 2, 3)
result should contain allOf (1, 2, 3)
result should contain theSameElementsAs (List(1, 2, 3))

You can enable the contain matcher syntax enabled by Aggregating on your own type U by defining an Aggregating[U] for the type and making it available implicitly.

Note, for an explanation of the difference between Containing and Aggregating, both of which enable contain matcher syntax, see the Containing versus Aggregating section of the main documentation for trait Containing.

Source: Aggregating.scala

Linear Supertypes

AnyRef, Any

Abstract Value Members

abstract def containsAllOf(aggregation: A, eles: Seq[Any]): Boolean

Implements contain allOf syntax for aggregations of type A.
Implements contain allOf syntax for aggregations of type A.
aggregation
an aggregation about which an assertion is being made
eles
elements all of which should be contained in the passed aggregation
returns
true if the passed aggregation contains all of the passed elements
abstract def containsAtLeastOneOf(aggregation: A, eles: Seq[Any]): Boolean

Implements contain atLeastOneOf syntax for aggregations of type A.
Implements contain atLeastOneOf syntax for aggregations of type A.
aggregation
an aggregation about which an assertion is being made
eles
elements at least one of which should be contained in the passed aggregation
returns
true if the passed aggregation contains at least one of the passed elements
abstract def containsAtMostOneOf(aggregation: A, eles: Seq[Any]): Boolean

Implements contain atMostOneOf syntax for aggregations of type A.
Implements contain atMostOneOf syntax for aggregations of type A.
aggregation
an aggregation about which an assertion is being made
eles
elements at most one of which should be contained in the passed aggregation
returns
true if the passed aggregation contains at most one of the passed elements
abstract def containsOnly(aggregation: A, eles: Seq[Any]): Boolean

Implements contain only syntax for aggregations of type A.
Implements contain only syntax for aggregations of type A.
aggregation
an aggregation about which an assertion is being made
eles
the only elements that should be contained in the passed aggregation
returns
true if the passed aggregation contains only the passed elements
abstract def containsTheSameElementsAs(leftAggregation: A, rightAggregation: GenTraversable[Any]): Boolean

Implements contain theSameElementsAs syntax for aggregations of type A.
Implements contain theSameElementsAs syntax for aggregations of type A.
leftAggregation
an aggregation about which an assertion is being made
rightAggregation
an aggregation that should contain the same elements as the passed leftAggregation
returns
true if the passed leftAggregation contains the same elements as the passed rightAggregation

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Aggregating | package enablers

trait Aggregating[-A] extends AnyRef

Abstract Value Members

abstract def containsAllOf(aggregation: A, eles: Seq[Any]): Boolean

abstract def containsAtLeastOneOf(aggregation: A, eles: Seq[Any]): Boolean

abstract def containsAtMostOneOf(aggregation: A, eles: Seq[Any]): Boolean

abstract def containsOnly(aggregation: A, eles: Seq[Any]): Boolean

abstract def containsTheSameElementsAs(leftAggregation: A, rightAggregation: GenTraversable[Any]): Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped