Class

net.liftweb.common

EmptyBox

Related Doc: package common

Permalink

sealed abstract class EmptyBox extends Box[Nothing] with Serializable

An EmptyBox is a Box containing no value. It can sometimes carry additional failure information, as in Failure and ParamFailure.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EmptyBox
  2. Box
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. class WithFilter extends AnyRef

    Permalink

    Makes Box play better with Scala for comprehensions.

    Makes Box play better with Scala for comprehensions.

    Definition Classes
    Box

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Equals
  2. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def $(f: (Box[Nothing]) ⇒ Unit): Box[Nothing]

    Permalink

    Alias for pass.

    Alias for pass.

    Definition Classes
    Box
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def ===[B >: Nothing](to: B): Boolean

    Permalink

    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

    Permalink

    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
    EmptyBoxBox
    Note

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

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

    Permalink

    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
    EmptyBoxBox
  8. def asA[B](implicit m: Manifest[B]): Box[B]

    Permalink

    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
    Box
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def choice[B](f1: (Nothing) ⇒ Box[B])(alternative: ⇒ Box[B]): Box[B]

    Permalink

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

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

    Definition Classes
    Box
  11. def clone(): AnyRef

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

    Permalink

    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
  13. final def collectFirst[B](pf: PartialFunction[Nothing, B]): Box[B]

    Permalink

    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
  14. def compoundFailMsg(msg: ⇒ String): Box[Nothing]

    Permalink

    Alias for ?~!.

    Alias for ?~!.

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

    Permalink

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

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

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

    Permalink

    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
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(other: Any): Boolean

    Permalink

    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
    Box → Equals → AnyRef → Any
  19. def exists(func: (Nothing) ⇒ Boolean): Boolean

    Permalink

    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
  20. def failMsg(msg: ⇒ String): Box[Nothing]

    Permalink

    Alias for ?~.

    Alias for ?~.

    Definition Classes
    Box
  21. def filter(p: (Nothing) ⇒ Boolean): Box[Nothing]

    Permalink

    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
    EmptyBoxBox
  22. def filterMsg(msg: String)(p: (Nothing) ⇒ Boolean): Box[Nothing]

    Permalink

    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

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

    Permalink

    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
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def flatMap[B](f: (Nothing) ⇒ Box[B]): Box[B]

    Permalink

    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
    Box
    Note

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

  26. def forall(func: (Nothing) ⇒ Boolean): Boolean

    Permalink

    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
  27. def foreach[U](f: (Nothing) ⇒ U): Unit

    Permalink

    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
  28. def fullXform[T](v: T)(f: (T) ⇒ (Nothing) ⇒ T): T

    Permalink

    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
  29. final def get: DoNotCallThisMethod

    Permalink

    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
  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  32. def isA[B](cls: Class[B]): Box[B]

    Permalink

    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
    Box
  33. def isDefined: Boolean

    Permalink

    Returns true if the box contains a value.

    Returns true if the box contains a value.

    Definition Classes
    Box
  34. def isEmpty: Boolean

    Permalink

    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
    EmptyBoxBox
  35. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  36. def iterator: Iterator[Nothing]

    Permalink

    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
  37. def javaIterator[B >: Nothing]: Iterator[B]

    Permalink

    Get a java.util.Iterator from the Box.

    Get a java.util.Iterator from the Box.

    Definition Classes
    Box
  38. def map[B](f: (Nothing) ⇒ B): Box[B]

    Permalink

    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
    Box
    Note

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

  39. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  40. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  41. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  42. def openOr[B](default: ⇒ B): B

    Permalink

    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
    EmptyBoxBox
  43. def openOrThrowException(justification: String): Nothing

    Permalink

    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
    EmptyBoxBox
    Exceptions thrown

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

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

    Permalink

    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
    EmptyBoxBox
  45. def pass(f: (Box[Nothing]) ⇒ Unit): Box[Nothing]

    Permalink

    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
  46. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  47. def productPrefix: String

    Permalink
    Definition Classes
    Product
  48. def run[T](in: ⇒ T)(f: (T, Nothing) ⇒ T): T

    Permalink

    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
  49. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  50. def toLeft[B](right: ⇒ B): Either[Nothing, B]

    Permalink

    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
  51. def toList: List[Nothing]

    Permalink

    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
  52. def toOption: Option[Nothing]

    Permalink

    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
  53. def toRight[B](left: ⇒ B): Either[B, Nothing]

    Permalink

    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
  54. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def withFilter(p: (Nothing) ⇒ Boolean): WithFilter

    Permalink

    Makes Box play better with Scala for comprehensions.

    Makes Box play better with Scala for comprehensions.

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

    Permalink

    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
    EmptyBoxBox

Inherited from Box[Nothing]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped