net.liftweb.common

Full

final case class Full[+A](value: A) extends Box[A] with Product with Serializable

Full is a Box containing a value.

Linear Supertypes
Box[A], Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Full
  2. Box
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Full(value: A)

Type Members

  1. class WithFilter extends AnyRef

    Play NiceLike with the Scala 2.

Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. def $(f: (Box[A]) ⇒ Unit): Box[A]

    Alias for pass

    Alias for pass

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

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

    Definition Classes
    Any
  7. def ===[B >: A](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.

    Definition Classes
    FullBox
  8. def ?~(msg: ⇒ String): Box[A]

    Transform an Empty to a Failure with the specified message.

    Transform an Empty to a Failure with the specified message.

    msg

    the failure message

    returns

    a Failure with the message if this Box is Empty

    Definition Classes
    Box
  9. def ?~!(msg: ⇒ String): Box[A]

    Transform an EmptyBox to a Failure with the specified message and chain the new Failure to any previous Failure represented by this Box.

    Transform an EmptyBox to a Failure with the specified message and chain the new Failure to any previous Failure represented by this Box.

    msg

    the failure message

    returns

    a Failure with the message if this Box is an Empty Box. Chain the messages if it is already a Failure

    Definition Classes
    Box
  10. def asA[B](implicit m: Manifest[B]): Box[B]

    Return a Full[B] if the contents of this Box is of type B, otherwise return Empty

    Return a Full[B] if the contents of this Box is of type B, otherwise return Empty

    Definition Classes
    FullBox
  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def canEqual(arg0: Any): Boolean

    Definition Classes
    Full → Equals
  13. def choice[B](f1: (A) ⇒ Box[B])(alternative: ⇒ Box[B]): Box[B]

    Apply the function f1 to the contents of this Box if available; if this is empty return the specified alternative.

    Apply the function f1 to the contents of this Box if available; if this is empty return the specified alternative.

    Definition Classes
    Box
  14. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. final def collect[B](pf: PartialFunction[A, 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
  16. def compoundFailMsg(msg: ⇒ String): Box[A]

    Alias for ?~!

    Alias for ?~!

    Definition Classes
    Box
  17. def dmap[B](dflt: ⇒ B)(f: (A) ⇒ B): B

    Equivalent to map(f).

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

    Definition Classes
    FullBox
  18. def elements: Iterator[A]

    Returns an Iterator over the value contained in this Box

    Returns an Iterator over the value contained in this Box

    Definition Classes
    FullBox
  19. final def eq(arg0: AnyRef): Boolean

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

    Determines equality based upon the contents of this Box instead of the box itself.

    Determines equality based upon the contents of this Box instead of the box itself. As a result, it is not symmetric. Which means that for

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

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

    Definition Classes
    Box → Equals → AnyRef → Any
  21. def exists(func: (A) ⇒ Boolean): Boolean

    Determine whether this Box contains a value which satisfies the specified predicate

    Determine whether this Box contains a value which satisfies the specified predicate

    returns

    true if this Box's value satisfies the specified predicate

    Definition Classes
    FullBox
  22. def failMsg(msg: ⇒ String): Box[A]

    Alias for ?~

    Alias for ?~

    Definition Classes
    Box
  23. def filter(p: (A) ⇒ Boolean): Box[A]

    Return this Box if it contains a value satisfying the specified predicate; Empty otherwise

    Return this Box if it contains a value satisfying the specified predicate; Empty otherwise

    returns

    this Box if it contains a value satisfying the specified predicate; Empty otherwise

    Definition Classes
    FullBox
  24. def filterMsg(msg: String)(p: (A) ⇒ Boolean): Box[A]

    Filter this box on the specified predicate, returning a Failure with the specified message if the predicate is not satisfied.

    Filter this box on the specified predicate, returning a Failure with the specified message if the predicate is not satisfied.

    msg

    the failure message

    p

    a predicate

    returns

    a Failure with the message if the predicate is not satisfied by the value contained in this Box

    Definition Classes
    Box
  25. def filterNot(f: (A) ⇒ Boolean): Box[A]

    Creates a Box if the current Box is Full and the value does not satisfy the predicate, f.

    Creates a Box if the current Box is Full and the value does not satisfy the predicate, f.

    f

    the predicate used to test value.

    returns

    a Box

    Definition Classes
    Box
  26. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. 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 result, or empty otherwise.

    Apply a function returning a Box to the value contained in this Box if it exists and return the result, or empty otherwise.

    returns

    the modified Box or empty

    Definition Classes
    FullBox
  28. def foreach[U](f: (A) ⇒ 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.

    Definition Classes
    FullBox
  29. final def getClass(): java.lang.Class[_]

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

    Definition Classes
    Full → AnyRef → Any
  31. def isA[B](clsOrg: Class[B]): Box[B]

    Return a Full[B] if the contents of this Box is an instance of the specified class, otherwise return Empty

    Return a Full[B] if the contents of this Box is an instance of the specified class, otherwise return Empty

    Definition Classes
    FullBox
  32. def isDefined: Boolean

    Returns true if the box contains a value.

    Returns true if the box contains a value.

    returns

    true if this Box contains a value

    Definition Classes
    Box
  33. def isEmpty: Boolean

    Returns true if this Box contains no value (is Empty or Failure or ParamFailure)

    Returns true if this Box contains no value (is Empty or Failure or ParamFailure)

    returns

    true if this Box contains no value

    Definition Classes
    FullBox
  34. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  35. def iterator: Iterator[A]

    Returns an Iterator over the value contained in this Box

    Returns an Iterator over the value contained in this Box

    Definition Classes
    Box
  36. def javaIterator[B >: A]: Iterator[B]

    Get a Java Iterator from the Box

    Get a Java Iterator from the Box

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

    Apply a function to the value contained in this Box if it exists and return a new Box containing the result, or empty otherwise.

    Apply a function to the value contained in this Box if it exists and return a new Box containing the result, or empty otherwise.

    returns

    the modified Box or empty

    Definition Classes
    FullBox
  38. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  39. final def notify(): Unit

    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  41. def openOr[B >: A](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

    returns

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

    Definition Classes
    FullBox
  42. def openOrThrowException(justification: String): A

    If you grew up on Java, you're used to Exceptions as part of your program logic.

    If you grew up on Java, you're used to Exceptions as part of your program logic. The Scala philosophy and the Lift philosophy is that exceptions are for exceptional conditions such as failure of an external resource (e.g., your database goes offline) rather than simply indicating that a parameter wasn't supplied or couldn't be parsed.

    Lift's Box and Scala's Option provide a mechanism for being explicit about a value existing or not existing rather than relying on a reference being not-null. However, extracting a value from a Box should be done correctly. Correctly can be (in order of use in David Pollak's code): a for comprehension; using map, flatMap or foreach; or using pattern matching.

    The only times when you should be using this method are: the value is guaranteed to be available based on a guard outside of the method using the Box or in tests. For example, User.currentUser.openOrThrowException("This snippet is used on pages where the user is logged in")

    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.

    This method replaces open_! because people used open_! and generally ignored the reason for the "!", so we're making it more explicit that this method should not commonly be used and should be justified when used.

    justification

    Justify why calling this method is okay and why it will not result in an Exception

    returns

    The contents of the Box if it has one or an exception if not

    Definition Classes
    FullBox
  43. def or[B >: A](alternative: ⇒ Box[B]): Box[B]

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

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

    Definition Classes
    FullBox
  44. def pass(f: (Box[A]) ⇒ Unit): Box[A]

    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.

    returns

    this Box

    Definition Classes
    Box
  45. def productArity: Int

    Definition Classes
    Full → Product
  46. def productElement(arg0: Int): Any

    Definition Classes
    Full → Product
  47. def productIterator: Iterator[Any]

    Definition Classes
    Product
  48. def productPrefix: String

    Definition Classes
    Full → Product
  49. def run[T](in: ⇒ T)(f: (T, A) ⇒ T): T

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

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

    returns

    the result of the function or a default value

    Definition Classes
    FullBox
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  51. def toLeft[B](right: ⇒ B): Either[A, B]

    An Either that is a Right with the given argument right if this is empty, or a Left if this is Fill with the Box's value

    An Either that is a Right with the given argument right if this is empty, or a Left if this is Fill with the Box's value

    Definition Classes
    FullBox
  52. def toList: List[A]

    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
    FullBox
  53. def toOption: Option[A]

    Returns the contents of this box in an Option if this is Full, or None if this is a empty (Empty, Failure or ParamFailure)

    Returns the contents of this box in an Option if this is Full, or None if this is a empty (Empty, Failure or ParamFailure)

    Definition Classes
    FullBox
  54. def toRight[B](left: ⇒ B): Either[B, A]

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

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

    Definition Classes
    FullBox
  55. def toString(): String

    Definition Classes
    Full → AnyRef → Any
  56. val value: A

  57. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  60. def withFilter(p: (A) ⇒ Boolean): WithFilter

    Makes Box play better with Scala 2.

    Makes Box play better with Scala 2.8 for comprehensions

    Definition Classes
    Box
  61. def ~>[T](errorCode: ⇒ T): Box[A]

    Transform an Empty to a ParamFailure with the specified typesafe parameter.

    Transform an Empty to a ParamFailure with the specified typesafe parameter.

    errorCode

    a value indicating the error

    returns

    a ParamFailure with the specified value

    Definition Classes
    Box

Deprecated Value Members

  1. final def openTheBox: A

    Return the value contained in this Box if it is Full; throw an exception otherwise.

    Return the value contained in this Box if it is Full; throw an exception otherwise. This means "don't use it unless you are 100% sure that the Box is Full and you should probably comment your code with the explanation of the guaranty. The better case for extracting the value out of a Box can be found at http://lift.la/scala-option-lift-box-and-how-to-make-your-co

    returns

    the value contained in this Box if it is full; throw an exception otherwise

    Definition Classes
    Box
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) use openOrThrowException, or better yet, do the right thing with your code and use map, flatMap or foreach

  2. final def open_!: A

    Return the value contained in this Box if it is Full; throw an exception otherwise.

    Return the value contained in this Box if it is Full; throw an exception otherwise.

    Using open_! in an example posted to the Lift mailing list may disqualify you for a helpful response.

    The method has a '!' in its name. This means "don't use it unless you are 100% sure that the Box is Full and you should probably comment your code with the explanation of the guaranty." The better case for extracting the value out of a Box can be found at http://lift.la/scala-option-lift-box-and-how-to-make-your-co

    returns

    the value contained in this Box if it is full; throw an exception otherwise

    Definition Classes
    Box
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) use openOrThrowException, or better yet, do the right thing with your code and use map, flatMap or foreach

  3. def productElements: Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use productIterator instead

Inherited from Box[A]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any