net.liftweb.common

Box

object Box extends BoxTrait

The Box companion object provides methods to create a Box from:

It also provides implicit methods to transform Option to Box, Box to Iterable, and Box to Option

go to: companion
linear super types: BoxTrait, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Box
  2. BoxTrait
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Value Members

  1. def !! [T] (in: T) : Box[T]

    Alias for legacyNullTest.

    Alias for legacyNullTest. This method allows one to encapsulate any object in a Box in a null-safe manner, returning Empty if the specified value is null.

    returns

    Full(in) if in is not null Empty otherwise

    definition classes: BoxTrait
  2. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  3. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  4. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  5. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  6. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  8. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  9. def apply [InType, OutType] (value: InType)(pf: PartialFunction[InType, OutType]) : Box[OutType]

    Apply the specified PartialFunction to the specified value and return the result in a Full Box; if the pf is undefined at that point return Empty.

    Apply the specified PartialFunction to the specified value and return the result in a Full Box; if the pf is undefined at that point return Empty.

    value

    the value to transform

    pf

    the partial function to use to transform the value

    returns

    a Full box containing the transformed value if pf.isDefinedAt(value); Empty otherwise

    definition classes: BoxTrait
  10. def apply [InType, OutType] (pf: PartialFunction[InType, OutType])(value: InType) : Box[OutType]

    Apply the specified PartialFunction to the specified value and return the result in a Full Box; if the pf is undefined at that point return Empty.

    Apply the specified PartialFunction to the specified value and return the result in a Full Box; if the pf is undefined at that point return Empty.

    pf

    the partial function to use to transform the value

    value

    the value to transform

    returns

    a Full box containing the transformed value if pf.isDefinedAt(value); Empty otherwise

    definition classes: BoxTrait
  11. def apply [T] (in: T) : Box[T]

    This method allows one to encapsulate any object in a Box in a null-safe manner, treating null values to Empty.

    This method allows one to encapsulate any object in a Box in a null-safe manner, treating null values to Empty. This is a parallel method to the Scala Option's apply method.

    returns

    Full(in) if in is not null; Empty otherwise

    definition classes: BoxTrait
  12. def apply [T] (in: List[T]) : Box[T]

    Transform a List with zero or one elements to a Box.

    Transform a List with zero or one elements to a Box.

    returns

    a Box object containing the head of a List. Full(x) if the List contains at least one element and Empty otherwise.

    definition classes: BoxTrait
  13. def apply [T] (in: Box[T]) : Box[T]

    Create a Box from the specified Option.

    Create a Box from the specified Option.

    returns

    a Box created from a Box. Full(x) if the Box is Full(x) and not null Empty otherwise

    definition classes: BoxTrait
  14. def apply [T] (in: Option[T]) : Box[T]

    Create a Box from the specified Option.

    Create a Box from the specified Option.

    returns

    a Box created from an Option. Full(x) if the Option is Some(x) and Empty otherwise

    definition classes: BoxTrait
  15. def asA [B] (in: T forSome { type T })(implicit m: Manifest[B]) : Box[B]

    Create a Full box containing the specified value if in is of type B; Empty otherwise.

    Create a Full box containing the specified value if in is of type B; Empty otherwise.

    definition classes: BoxTrait
  16. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  17. implicit def box2Iterable [T] (in: Box[T]) : Iterable[T]

    This implicit transformation allows one to use a Box as an Iterable

    This implicit transformation allows one to use a Box as an Iterable

    returns

    List(in) if this Box is Full(in); Nil otherwise

    attributes: implicit
    definition classes: BoxTrait
  18. implicit def box2Option [T] (in: Box[T]) : Option[T]

    This implicit transformation allows one to use a Box as an Option.

    This implicit transformation allows one to use a Box as an Option.

    returns

    Some(in) if this Box is Full(in); None otherwise

    attributes: implicit
    definition classes: BoxTrait
  19. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  20. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  21. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  22. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  23. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  24. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  25. def isA [A, B] (in: A, clz: Class[B]) : Box[B]

    Create a Full box containing the specified value if "in" is an instance of the specified class, or Empty otherwise.

    Create a Full box containing the specified value if "in" is an instance of the specified class, or Empty otherwise.

    definition classes: BoxTrait
  26. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  27. def legacyNullTest [T] (in: T) : Box[T]

    This method allows one to encapsulate any object in a Box in a null-safe manner, treating null values to Empty

    This method allows one to encapsulate any object in a Box in a null-safe manner, treating null values to Empty

    returns

    Full(in) if in is not null; Empty otherwise

    definition classes: BoxTrait
  28. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  29. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  30. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  31. implicit def option2Box [T] (in: Option[T]) : Box[T]

    This implicit transformation allows one to use an Option as a Box.

    This implicit transformation allows one to use an Option as a Box.

    returns

    a Box object from an Option. Full(in) if the Option is Some(in); Empty otherwise

    attributes: implicit
    definition classes: BoxTrait
  32. val primativeMap : Map[Class[_], Class[_]]

    definition classes: BoxTrait
  33. def readResolve () : AnyRef

    attributes: protected
  34. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  35. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  36. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  37. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  38. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from BoxTrait

Inherited from AnyRef

Inherited from Any