sealed case class Failure(msg: String, exception: Box[Throwable], chain: Box[Failure]) extends EmptyBox with Product with Serializable

A Failure is an EmptyBox with an additional failure message explaining the reason for its being empty. It can also optionally provide an exception and/or a chain of previous Failures that may have caused this one.

Linear Supertypes
EmptyBox, Box[Nothing], Serializable, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
ParamFailure
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Failure
  2. EmptyBox
  3. Box
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Failure(msg: String, exception: Box[Throwable], chain: Box[Failure])

Type Members

  1. class WithFilter extends AnyRef

    Makes Box play better with Scala for comprehensions.

    Makes Box play better with Scala for comprehensions.

    Definition Classes
    Box
  2. type A = Nothing

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def $(f: (Box[Nothing]) ⇒ Unit): Box[Nothing]

    Alias for pass.

    Alias for pass.

    Definition Classes
    Box
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def ===[B >: Nothing](to: B): Boolean

    Returns true if the value contained in this box is equal to the specified value.

    Returns true if the value contained in this box is equal to the specified value. This is the same thing that == does when it's handed a value that isn't a Box, but using this is recommended because it's clearer that the behavior will be different than the usual expectation.

    Definition Classes
    Box
  6. def ?~(msg: ⇒ String): Failure

    Transform an Empty to a Failure with the specified message.

    Transform an Empty to a Failure with the specified message. Otherwise returns the same box.

    returns

    A Failure with the message if this Box is Empty, this box otherwise.

    Definition Classes
    Failure → EmptyBox → Box
    Note

    This means a Failure will also remain unchanged; see ?~! to change these.

  7. def ?~!(msg: ⇒ String): Failure

    Chain the given msg as a Failure ahead of any failures this Box may represent.

    Chain the given msg as a Failure ahead of any failures this Box may represent.

    If this is an Empty, this method behaves like ?~. If it is a Failure, however, this method returns a new Failure with the given msg and with its chain set to this Failure.

    As with ?~, if this is a Full, we return it unchanged.

    returns

    A Failure with the message if this Box is an Empty box. Chain this box to the new Failure if this is a Failure. The unchanged box if it is a Full.

    Definition Classes
    Failure → EmptyBox → Box
  8. def asA[B](implicit m: Manifest[B]): Box[B]

    Create a Full box containing the specified value if this box's value is of type B and Empty otherwise.

    Create a Full box containing the specified value if this box's value is of type B and Empty otherwise.

    For example:

    scala> Full("boom").asA[Int]
res0: net.liftweb.common.Box[Int] = Empty

scala> Full(5).asA[Int]
res1: net.liftweb.common.Box[Int] = Full(5)
    Definition Classes
    Failure → Box
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val chain: Box[Failure]
  11. def choice[B](f1: (Nothing) ⇒ Box[B])(alternative: ⇒ Box[B]): Box[B]

    Equivalent to flatMap(f1).or(alternative).

    Equivalent to flatMap(f1).or(alternative).

    Definition Classes
    Box
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  13. final def collect[B](pf: PartialFunction[Nothing, B]): Box[B]

    If the partial function is defined at the current Box's value, apply the partial function.

    If the partial function is defined at the current Box's value, apply the partial function.

    Definition Classes
    Box
  14. final def collectFirst[B](pf: PartialFunction[Nothing, B]): Box[B]

    An alias for collect.

    An alias for collect.

    Although this function is different for true collections, because Box is really a collection of 1, the two functions are identical.

    Definition Classes
    Box
  15. def compoundFailMsg(msg: ⇒ String): Box[Nothing]

    Alias for ?~!.

    Alias for ?~!.

    Definition Classes
    Box
  16. def dmap[B](dflt: ⇒ B)(f: (Nothing) ⇒ B): B

    Equivalent to map(f).openOr(dflt).

    Equivalent to map(f).openOr(dflt).

    Definition Classes
    Box
  17. def elements: Iterator[Nothing]

    Returns an Iterator over the value contained in this Box, if any.

    Returns an Iterator over the value contained in this Box, if any.

    Definition Classes
    Box
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(other: Any): Boolean

    For Full and Empty, this has the expected behavior.

    For Full and Empty, this has the expected behavior. Equality in terms of Failure checks for equivalence of failure causes:

    Failure("boom") == Failure("boom")
Failure("bam") != Failure("boom")
Failure("boom", Full(someException), Empty) != Failure("boom")

    For other values, determines equality based upon the contents of this Box instead of the box itself. As a result, it is not symmetric. As an example:

    val foo = "foo"
val boxedFoo = Full(foo)
foo == boxedFoo //is false
boxedFoo == foo //is true

    It is safest to use === explicitly when you're looking for this behavior, and use == only for box-to-box comparisons:

    Full("magic") == Full("magic")
Full("magic") != Full("another")
Full("magic") != Empty
Full("magic") != Failure("something's gone wrong")
    Definition Classes
    Failure → Box → Equals → AnyRef → Any
  20. val exception: Box[Throwable]
  21. def exceptionChain: List[Throwable]

    Return a list of the exceptions that led to this Failure.

    Return a list of the exceptions that led to this Failure. First, unflattens the list of causes of this Failure's exception. Then, if this Failure has a chain, walks down it and concatenates their exceptionChain to the end of this one's.

    returns

    A single list of Throwables from the most direct cause to the least direct cause of this Failure.

  22. def exists(func: (Nothing) ⇒ Boolean): Boolean

    If this Box contains a value and it satisfies the specified func, return true.

    If this Box contains a value and it satisfies the specified func, return true. Otherwise, return false.

    returns

    true if this Box does contain a value and it satisfies the predicate.

    Definition Classes
    Box
  23. def failMsg(msg: ⇒ String): Box[Nothing]

    Alias for ?~.

    Alias for ?~.

    Definition Classes
    Box
  24. def failureChain: List[Failure]

    Flatten the Failure chain to a List where this Failure is at the head.

  25. def filter(p: (Nothing) ⇒ Boolean): Box[Nothing]

    If this Box contains a value and it satisfies the specified predicate, return the Box unchanged.

    If this Box contains a value and it satisfies the specified predicate, return the Box unchanged. Otherwise, return an Empty.

    Definition Classes
    EmptyBox → Box
  26. def filterMsg(msg: String)(p: (Nothing) ⇒ Boolean): Box[Nothing]

    If this Box contains a value and it satisfies the specified predicate, return the Box unchanged.

    If this Box contains a value and it satisfies the specified predicate, return the Box unchanged. Otherwise, return a Failure with the given msg.

    returns

    A Failure with the message if the box is empty or the predicate is not satisfied by the value contained in this Box.

    Definition Classes
    Box
    See also

    filter

  27. def filterNot(f: (Nothing) ⇒ Boolean): Box[Nothing]

    If this Box contains a value and it does not satisfy the specified f, return the Box unchanged.

    If this Box contains a value and it does not satisfy the specified f, return the Box unchanged. Otherwise, return an Empty.

    Definition Classes
    Box
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def flatMap[B](f: (A) ⇒ Box[B]): Box[B]

    Apply a function returning a Box to the value contained in this Box if it exists and return the resulting Box.

    Apply a function returning a Box to the value contained in this Box if it exists and return the resulting Box. If this Box is not already Full, return this box unchanged.

    Definition Classes
    Failure → Box
    Note

    This means that using flatMap with a Failure will preserve the Failure.

  30. def flatten[B](implicit ev: <:<[Nothing, Box[B]]): Box[B]
    Definition Classes
    Box
  31. def flip[B](flipFn: (EmptyBox) ⇒ B): Box[B]

    Returns a Full box containing the results of applying flipFn to this box if it is a Failure, ParamFailure or Empty.

    Returns a Full box containing the results of applying flipFn to this box if it is a Failure, ParamFailure or Empty. Returns Empty if this box is Full. In other words, it "flips" the full/empty status of this Box.

    Definition Classes
    Box
  32. def forall(func: (Nothing) ⇒ Boolean): Boolean

    If this Box contains a value and it does not satisfy the specified func, return false.

    If this Box contains a value and it does not satisfy the specified func, return false. Otherwise, return true.

    returns

    true If the Box is empty, or if its value satisfies the predicate.

    Definition Classes
    Box
  33. def foreach[U](f: (Nothing) ⇒ U): Unit

    Perform a side effect by calling the specified function with the value contained in this box.

    Perform a side effect by calling the specified function with the value contained in this box. The function does not run if this Box is empty.

    Definition Classes
    Box
  34. def fullXform[T](v: T)(f: (T) ⇒ (Nothing) ⇒ T): T

    If the Box is Full, apply the transform function f on the value v; otherwise, just return the value untransformed.

    If the Box is Full, apply the transform function f on the value v; otherwise, just return the value untransformed.

    The transform function is expected to be a function that will take the value v and produce a function from the value in the box to a new value of the same type as v.

    For example:

    val myBox = Full(10)
myBox.fullXForm("No teddy bears left.")({ message =>
  { teddyBears: Int =>
    s"$message Oh wait, there are $teddyBears left!"
  }
})
    T

    The type of the initial value, default value, and transformed value.

    returns

    If the Box is Full, the value once transformed by the function returned by f. Otherwise, the initial value v.

    Definition Classes
    Box
  35. final def get: DoNotCallThisMethod

    Exists to avoid the implicit conversion from Box to Option.

    Exists to avoid the implicit conversion from Box to Option. Opening a Box unsafely should be done using openOrThrowException.

    This method always throws an exception.

    Definition Classes
    Box
  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. def isA[B](cls: Class[B]): Box[B]

    If this box is Full and contains an object of type B, returns a Full of type Box[B].

    If this box is Full and contains an object of type B, returns a Full of type Box[B]. Otherwise, returns Empty.

    This is basically a Java-friendly version of asA, which you should prefer when using Scala.

    For example:

    scala> Full("boom").isA(classOf[Int])
res0: net.liftweb.common.Box[Int] = Empty

scala> Full(5).isA(classOf[Int])
res1: net.liftweb.common.Box[Int] = Full(5)
    Definition Classes
    Failure → Box
  38. def isDefined: Boolean

    Returns true if the box contains a value.

    Returns true if the box contains a value.

    Definition Classes
    Box
  39. def isEmpty: Boolean

    Returns true if this Box contains no value (i.e., it is Empty or Failure or ParamFailure).

    Returns true if this Box contains no value (i.e., it is Empty or Failure or ParamFailure).

    Definition Classes
    EmptyBox → Box
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def iterator: Iterator[Nothing]

    Returns an Iterator over the value contained in this Box, if any.

    Returns an Iterator over the value contained in this Box, if any.

    Synonym for elements.

    Definition Classes
    Box
  42. def javaIterator[B >: Nothing]: Iterator[B]

    Get a java.util.Iterator from the Box.

    Get a java.util.Iterator from the Box.

    Definition Classes
    Box
  43. def map[B](f: (A) ⇒ B): Box[B]

    Apply a function to the value contained in this Box if it exists and return a Full containing the result.

    Apply a function to the value contained in this Box if it exists and return a Full containing the result. If this Box is not already Full, return the unchanged box.

    Definition Classes
    Failure → Box
    Note

    This means that using map with a Failure will preserve the Failure.

  44. def messageChain: String

    Reduce this Failure's message and the messages of all chained failures a to a single String.

    Reduce this Failure's message and the messages of all chained failures a to a single String. The resulting string links each step in the failure chain with <-, and this Failure's message is last.

    For example:

    scala> Failure("It's all gone wrong.") ?~! "Something's gone wrong." ?~! "It's all sideways"
res0: net.liftweb.common.Failure = Failure(It's all sideways,Empty,
        Full(Failure(Something's gone wrong.,Empty,
          Full(Failure(It's all gone wrong.,Empty,Empty)))))
scala> res0.messageChain
res1: String = It's all sideways <- Something's gone wrong. <- It's all gone wrong.
  45. val msg: String
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. def openOr[B](default: ⇒ B): B

    Return the value contained in this Box if it is full; otherwise return the specified default.

    Return the value contained in this Box if it is full; otherwise return the specified default. Equivalent to Option's getOrElse.

    Definition Classes
    EmptyBox → Box
  50. def openOrThrowException(justification: ⇒ String): Nothing

    The only time when you should be using this method is if the value is guaranteed to be available based on a guard outside of the method.

    The only time when you should be using this method is if the value is guaranteed to be available based on a guard outside of the method. In these cases, please provide that information in the justification String. For example, User.currentUser.openOrThrowException("This snippet is only used on pages where the user is logged in"). For tests, use == or === instead. See the class documentation for more information.

    A valid justification for using this method should not be "I want my code to fail fast when I call it." Using exceptions in the core logic of your application should be strongly discouraged.

    justification

    Justify why calling this method is okay and why it will not result in an exception being thrown. This serves both as mandatory documentation and as a very clear indication of what unexpected thing happened in the event you were wrong about the guard.

    returns

    The contents of the Box if it is Full.

    Definition Classes
    Failure → EmptyBox → Box
    Exceptions thrown

    NullPointerException If you attempt to call it on an EmptyBox, with a message that includes the provided justification.

  51. def or[B](alternative: ⇒ Box[B]): Box[B]

    Return this Box if Full, or the specified alternative if it is empty.

    Return this Box if Full, or the specified alternative if it is empty. Equivalent to Option's orElse.

    Definition Classes
    EmptyBox → Box
  52. def pass(f: (Box[Nothing]) ⇒ Unit): Box[Nothing]

    Perform a side effect by passing this Box to the specified function and return this Box unmodified.

    Perform a side effect by passing this Box to the specified function and return this Box unmodified. Similar to foreach, except that foreach returns Unit, while this method allows chained use of the Box.

    returns

    This box.

    Definition Classes
    Box
  53. def rootExceptionCause: Box[Throwable]

    Gets the deepest exception cause, if any, which is ostensibly the root cause of this Failure.

  54. def run[T](in: ⇒ T)(f: (T, Nothing) ⇒ T): T

    This method calls the specified function with the specified in value and the value contained in this Box.

    This method calls the specified function with the specified in value and the value contained in this Box. If this box is empty, returns the in value directly.

    returns

    The result of the function or the in value.

    Definition Classes
    Box
  55. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  56. def toLeft[B](right: ⇒ B): Either[Nothing, B]

    An Either that is a Right with the given argument right if this is empty, or a Left with the boxed value if this is Full.

    An Either that is a Right with the given argument right if this is empty, or a Left with the boxed value if this is Full.

    Definition Classes
    Box
  57. def toList: List[Nothing]

    Returns a List of one element if this is Full, or an empty list if empty.

    Returns a List of one element if this is Full, or an empty list if empty.

    Definition Classes
    Box
  58. def toOption: Option[Nothing]

    Returns the contents of this box wrapped in Some if this is Full, or None if this is empty (meaning an Empty, Failure or ParamFailure).

    Returns the contents of this box wrapped in Some if this is Full, or None if this is empty (meaning an Empty, Failure or ParamFailure).

    Definition Classes
    Box
  59. def toRight[B](left: ⇒ B): Either[B, Nothing]

    An Either that is a Left with the given argument left if this is empty, or a Right with the boxed value if this is Full.

    An Either that is a Left with the given argument left if this is empty, or a Right with the boxed value if this is Full.

    Definition Classes
    Box
  60. def transform[B >: Nothing](transformFn: PartialFunction[Box[Nothing], Box[B]]): Box[B]

    Transforms this box using the transformFn.

    Transforms this box using the transformFn. If transformFn is defined for this box, returns the result of applying transformFn to it. Otherwise, returns this box unchanged.

    If you want to change the content of a Full box, using map or collect might be better suited to that purpose. If you want to convert an Empty, Failure or a ParamFailure into a Full box, you should use flip.

    Definition Classes
    Box
    Example: 

    1. // Returns Full("alternative") because the partial function covers the case.
Full("error") transform { case Full("error") => Full("alternative") }

// Returns Full(1), this Full box unchanged, because the partial function doesn't cover the case.
Full(1) transform { case Full(2) => Failure("error") }

// Returns this Failure("another-error") unchanged because the partial function doesn't cover the case.
Failure("another-error") transform { case Failure("error", Empty, Empty) => Full("alternative") }

// Returns Full("alternative") for an Empty box since `partialFn` is defined for Empty
Empty transform { case Empty => Full("alternative") }

// Returns Empty because the partial function is not defined for Empty
Empty transform { case Failure("error", Empty, Empty) => Full("alternative") }
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  64. def withFilter(p: (Nothing) ⇒ Boolean): WithFilter

    Makes Box play better with Scala for comprehensions.

    Makes Box play better with Scala for comprehensions.

    Definition Classes
    Box
  65. def ~>[T](errorCode: ⇒ T): ParamFailure[T]

    Transform an Empty or Failure to a ParamFailure with the specified type-safe parameter.

    Transform an Empty or Failure to a ParamFailure with the specified type-safe parameter.

    errorCode

    A value indicating the error.

    returns

    A ParamFailure with the specified value, unless this is already a ParamFailure or a Full. If this is a Failure, the ParamFailure will preserve the message of the Failure.

    Definition Classes
    Failure → EmptyBox → Box

Inherited from EmptyBox

Inherited from Box[Nothing]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped