Packages

c

akka.util.Helpers

Requiring

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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Requiring
  2. AnyVal
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
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
    This member is added by an implicit conversion from Requiring[A] toany2stringadd[Requiring[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Requiring[A], B)
    Implicit
    This member is added by an implicit conversion from Requiring[A] toArrowAssoc[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
    This member is added by an implicit conversion from Requiring[A] toEnsuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (Requiring[A]) => Boolean): Requiring[A]
    Implicit
    This member is added by an implicit conversion from Requiring[A] toEnsuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): Requiring[A]
    Implicit
    This member is added by an implicit conversion from Requiring[A] toEnsuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): Requiring[A]
    Implicit
    This member is added by an implicit conversion from Requiring[A] toEnsuring[Requiring[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Requiring[A] toStringFormat[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

Deprecated Value Members

  1. def [B](y: B): (Requiring[A], B)
    Implicit
    This member is added by an implicit conversion from Requiring[A] toArrowAssoc[Requiring[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyVal

Inherited from Any

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

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

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

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

Ungrouped