scala.collection.TraversableLike

WithFilter

class WithFilter extends FilterMonadic[A, Repr]

A class supporting filtered operations. Instances of this class are returned by method withFilter.

Source
TraversableLike.scala
Linear Supertypes
FilterMonadic[A, Repr], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. WithFilter
  2. FilterMonadic
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WithFilter (p: (A) ⇒ Boolean)

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Equivalent to x.hashCode except for boxed numeric types.

    Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.

    returns

    a hash value consistent with ==

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

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Attributes
    final
    Definition Classes
    Any
  7. def clone (): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

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

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Attributes
    final
    Definition Classes
    AnyRef
  9. def equals (arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. See equals in Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  10. def finalize (): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. def flatMap [B] (f: (A) ⇒ TraversableOnce[B]): Traversable[B]

    [use case] Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p and concatenating the results.

    [use case]

    Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p and concatenating the results.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

    a new collection of type That resulting from applying the given collection-valued function f to each element of the outer traversable collection that satisfies predicate p and concatenating the results.

    Attributes
    abstract
  12. def flatMap [B, That] (f: (A) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

    Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p and concatenating the results.

    Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p and concatenating the results.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each element.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That resulting from applying the given collection-valued function f to each element of the outer traversable collection that satisfies predicate p and concatenating the results.

    Definition Classes
    WithFilterFilterMonadic
  13. def foreach (f: (A) ⇒ Unit): Unit

    [use case] Applies a function f to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    [use case]

    Applies a function f to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    Attributes
    abstract
  14. def foreach [U] (f: (A) ⇒ U): Unit

    Applies a function f to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    Applies a function f to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    U

    the type parameter describing the result of function f. This result will always be ignored. Typically U is Unit, but this is not necessary.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    Definition Classes
    WithFilterFilterMonadic
  15. def getClass (): java.lang.Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Attributes
    final
    Definition Classes
    AnyRef → Any
  16. def hashCode (): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

    the hash code value for this object.

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

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Attributes
    final
    Definition Classes
    Any
  18. def map [B] (f: (A) ⇒ B): Traversable[B]

    [use case] Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    [use case]

    Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

    a new collection of type That resulting from applying the given function f to each element of the outer traversable collection that satisfies predicate p and collecting the results.

    Attributes
    abstract
  19. def map [B, That] (f: (A) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

    Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    Builds a new collection by applying a function to all elements of the outer traversable collection containing this WithFilter instance that satisfy predicate p.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each element.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That resulting from applying the given function f to each element of the outer traversable collection that satisfies predicate p and collecting the results.

    Definition Classes
    WithFilterFilterMonadic
  20. def ne (arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Attributes
    final
    Definition Classes
    AnyRef
  21. def notify (): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Attributes
    final
    Definition Classes
    AnyRef
  22. def notifyAll (): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

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

    Attributes
    final
    Definition Classes
    AnyRef
  24. def toString (): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  25. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  28. def withFilter (q: (A) ⇒ Boolean): WithFilter

    Further refines the filter for this traversable collection.

    Further refines the filter for this traversable collection.

    q

    the predicate used to test elements.

    returns

    an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this traversable collection which satisfy the predicate q in addition to the predicate p.

    Definition Classes
    WithFilterFilterMonadic

Inherited from FilterMonadic[A, Repr]

Inherited from AnyRef

Inherited from Any