akka.util.Helpers

Requiring

Related Doc: package Helpers

implicit final class Requiring[A] extends AnyVal

Implicit class providing requiring methods. This class is based on Predef.ensuring in the Scala standard library. The difference is that this class's methods throw IllegalArgumentExceptions rather than AssertionErrors.

An example adapted from Predef's documentation:

import akka.util.Helpers.Requiring

def addNaturals(nats: List[Int]): Int = {
  require(nats forall (_ >= 0), "List contains negative numbers")
  nats.foldLeft(0)(_ + _)
} requiring(_ >= 0)
Annotations
@inline()
Source
Helpers.scala
Linear Supertypes
AnyVal, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Requiring
  2. AnyVal
  3. Any
Implicitly
  1. by Requiring
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Requiring(value: A)

    value

    The value to check.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  2. final def ##(): Int

    Definition Classes
    Any

  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to any2stringadd[Requiring[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Requiring[A], B)

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to ArrowAssoc[Requiring[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def ensuring(cond: (Requiring[A]) ⇒ Boolean, msg: ⇒ Any): Requiring[A]

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to Ensuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  8. def ensuring(cond: (Requiring[A]) ⇒ Boolean): Requiring[A]

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to Ensuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: Boolean, msg: ⇒ Any): Requiring[A]

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to Ensuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean): Requiring[A]

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to Ensuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to StringFormat[Requiring[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  12. def getClass(): Class[_ <: AnyVal]

    Definition Classes
    AnyVal → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. def requiring(cond: (A) ⇒ Boolean, msg: ⇒ Any): A

    Check that a condition is true for the value.

    Check that a condition is true for the value. If true, return value, otherwise throw an IllegalArgumentException with the given message.

    cond

    The function used to check the value.

    msg

    The message to report if the condition isn't met.

    Annotations
    @inline()

  15. def requiring(cond: Boolean, msg: ⇒ Any): A

    Check that a condition is true.

    Check that a condition is true. If true, return value, otherwise throw an IllegalArgumentException with the given message.

    cond

    The condition to check.

    msg

    The message to report if the condition isn't met.

    Annotations
    @inline()

  16. def toString(): String

    Definition Classes
    Any

  17. val value: A

    The value to check.

  18. def →[B](y: B): (Requiring[A], B)

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to ArrowAssoc[Requiring[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def requiring(cond: (Requiring[A]) ⇒ Boolean, msg: ⇒ Any): Requiring[A]

    Check that a condition is true for the value.

    Check that a condition is true for the value. If true, return value, otherwise throw an IllegalArgumentException with the given message.

    cond

    The function used to check the value.

    msg

    The message to report if the condition isn't met.

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to Requiring[Requiring[A]] performed by method Requiring in akka.util.Helpers.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (requiring: Requiring[Requiring[A]]).requiring(cond, msg)
    Annotations
    @inline()

  2. def requiring(cond: Boolean, msg: ⇒ Any): Requiring[A]

    Check that a condition is true.

    Check that a condition is true. If true, return value, otherwise throw an IllegalArgumentException with the given message.

    cond

    The condition to check.

    msg

    The message to report if the condition isn't met.

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to Requiring[Requiring[A]] performed by method Requiring in akka.util.Helpers.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (requiring: Requiring[Requiring[A]]).requiring(cond, msg)
    Annotations
    @inline()

  3. val value: Requiring[A]

    The value to check.

    The value to check.

    Implicit information
    This member is added by an implicit conversion from Requiring[A] to Requiring[Requiring[A]] performed by method Requiring in akka.util.Helpers.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (requiring: Requiring[Requiring[A]]).value

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion Requiring from Requiring[A] to Requiring[Requiring[A]]

Inherited by implicit conversion any2stringadd from Requiring[A] to any2stringadd[Requiring[A]]

Inherited by implicit conversion StringFormat from Requiring[A] to StringFormat[Requiring[A]]

Inherited by implicit conversion Ensuring from Requiring[A] to Ensuring[Requiring[A]]

Inherited by implicit conversion ArrowAssoc from Requiring[A] to ArrowAssoc[Requiring[A]]

Ungrouped