OptVar

Instance Constructors

new OptVar()(implicit m: Manifest[A])

Type Members

class WithFilter extends AnyRef

We need a whole WithFilter class to honor the "doesn't create a new collection" contract even though it seems unlikely to matter much in a collection with max size 1.

Abstract Value Members

abstract def getAll(implicit action: Action): Map[String, Any]

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def collect[B](pf: PartialFunction[A, B])(implicit action: Action): Option[B]

Returns a scala.Some containing the result of applying pf to this scala.Option's contained value, if this option is nonempty and pf is defined for that value.
Returns a scala.Some containing the result of applying pf to this scala.Option's contained value, if this option is nonempty and pf is defined for that value. Returns None otherwise.
pf
the partial function.
returns
the result of applying pf to this scala.Option's value (if possible), or None.
Annotations
@inline()
Example:
1. // Returns Some(HTTP) because the partial function covers the case. Some("http") collect {case "http" => "HTTP"} // Returns None because the partial function doesn't cover the case. Some("ftp") collect {case "http" => "HTTP"} // Returns None because None is passed to the collect method. None collect {case value => value}
final def contains[A1 >: A](elem: A1)(implicit action: Action): Boolean

Tests whether the option contains a given value as an element.
Tests whether the option contains a given value as an element.
elem
the element to test.
returns
true if the option has an element that is equal (as determined by ==) to elem, false otherwise.
Example:
1. // Returns true because Some instance contains string "something" which equals "something". Some("something") contains "something" // Returns false because "something" != "anything". Some("something") contains "anything" // Returns false when method called on None. None contains "anything"
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def exists(p: (A) ⇒ Boolean)(implicit action: Action): Boolean

Returns true if this option is nonempty and the predicate p returns true when applied to this scala.Option's value.
Returns true if this option is nonempty and the predicate p returns true when applied to this scala.Option's value. Otherwise, returns false.
p
the predicate to test

Annotations
@inline()
final def filter(p: (A) ⇒ Boolean)(implicit action: Action): Option[A]

Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns true.
Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns true. Otherwise, return None.
p
the predicate used for testing.

Annotations
@inline()
final def filterNot(p: (A) ⇒ Boolean)(implicit action: Action): Option[A]

Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns false.
Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns false. Otherwise, return None.
p
the predicate used for testing.

Annotations
@inline()
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def flatMap[B](f: (A) ⇒ Option[B])(implicit action: Action): Option[B]

Returns the result of applying f to this scala.Option's value if this scala.Option is nonempty.
Returns the result of applying f to this scala.Option's value if this scala.Option is nonempty. Returns None if this scala.Option is empty. Slightly different from map in that f is expected to return an scala.Option (which could be None).
f
the function to apply

Annotations
@inline()
See also
foreach
map
def flatten[B](implicit ev: <:<[A, Option[B]], action: Action): Option[B]
final def fold[B](ifEmpty: ⇒ B)(f: (A) ⇒ B)(implicit action: Action): B

Returns the result of applying f to this scala.Option's value if the scala.Option is nonempty.
Returns the result of applying f to this scala.Option's value if the scala.Option is nonempty. Otherwise, evaluates expression ifEmpty.
ifEmpty
the expression to evaluate if empty.
f
the function to apply if nonempty.

Annotations
@inline()
Note
This is equivalent to scala.Option map f getOrElse ifEmpty.
final def forall(p: (A) ⇒ Boolean)(implicit action: Action): Boolean

Returns true if this option is empty or the predicate p returns true when applied to this scala.Option's value.
Returns true if this option is empty or the predicate p returns true when applied to this scala.Option's value.
p
the predicate to test

Annotations
@inline()
final def foreach[U](f: (A) ⇒ U)(implicit action: Action): Unit

Apply the given procedure f to the option's value, if it is nonempty.
Apply the given procedure f to the option's value, if it is nonempty. Otherwise, do nothing.
f
the procedure to apply.

Annotations
@inline()
See also
flatMap
map
def get(implicit action: Action): A
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getOrElse[B >: A](default: ⇒ B)(implicit action: Action): B

Returns the option's value if the option is nonempty, otherwise return the result of evaluating default.
Returns the option's value if the option is nonempty, otherwise return the result of evaluating default.
default
the default expression.

Annotations
@inline()
def hashCode(): Int

Definition Classes
AnyRef → Any
def isDefined(implicit action: Action): Boolean

Returns true if the option is an instance of scala.Some, false otherwise.
def isEmpty(implicit action: Action): Boolean

Returns true if the option is None, false otherwise.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def iterator(implicit action: Action): Iterator[A]

Returns a singleton iterator returning the scala.Option's value if it is nonempty, or an empty iterator if the option is empty.
val key: String

Attributes
protected[this]
final def map[B](f: (A) ⇒ B)(implicit action: Action): Option[B]

Returns a scala.Some containing the result of applying f to this scala.Option's value if this scala.Option is nonempty.
Returns a scala.Some containing the result of applying f to this scala.Option's value if this scala.Option is nonempty. Otherwise return None.
f
the function to apply

Annotations
@inline()
Note
This is similar to flatMap except here, f does not need to wrap its result in an scala.Option.
See also
foreach
flatMap
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def nonEmpty(implicit action: Action): Boolean

Returns false if the option is None, true otherwise.
Returns false if the option is None, true otherwise.

Note
Implemented here to avoid the implicit conversion to Iterable.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def orElse[B >: A](alternative: ⇒ Option[B])(implicit action: Action): Option[B]

Returns this scala.Option if it is nonempty, otherwise return the result of evaluating alternative.
Returns this scala.Option if it is nonempty, otherwise return the result of evaluating alternative.
alternative
the alternative expression.

Annotations
@inline()
final def orNull[A1 >: A](implicit ev: <:<[Null, A1], action: Action): A1

Returns the option's value if it is nonempty, or null if it is empty.
Returns the option's value if it is nonempty, or null if it is empty. Although the use of null is discouraged, code written to use scala.Option must often interface with code that expects and returns nulls.
Annotations
@inline()
Example:
1. val initalText: Option[String] = getInitialText val textField = new JComponent(initalText.orNull,20)
def remove()(implicit action: Action): Option[A]
def set[B >: A](value: B)(implicit action: Action): Unit
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toLeft[X](right: ⇒ X)(implicit action: Action): Product with Serializable with Either[A, X]

Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this scala.Option's value if this scala.Option is nonempty.
Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this scala.Option's value if this scala.Option is nonempty.
right
the expression to evaluate and return if this is empty

Annotations
@inline()
See also
toRight
def toList(implicit action: Action): List[A]

Returns a singleton list containing the scala.Option's value if it is nonempty, or the empty list if the scala.Option is empty.
def toOption(implicit action: Action): Option[A]
final def toRight[X](left: ⇒ X)(implicit action: Action): Product with Serializable with Either[X, A]

Returns a scala.util.Left containing the given argument left if this scala.Option is empty, or a scala.util.Right containing this scala.Option's value if this is nonempty.
Returns a scala.util.Left containing the given argument left if this scala.Option is empty, or a scala.util.Right containing this scala.Option's value if this is nonempty.
left
the expression to evaluate and return if this is empty

Annotations
@inline()
See also
toLeft
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
final def withFilter(p: (A) ⇒ Boolean)(implicit action: Action): WithFilter

Necessary to keep scala.Option from being implicitly converted to scala.collection.Iterable in for comprehensions.
Necessary to keep scala.Option from being implicitly converted to scala.collection.Iterable in for comprehensions.

Annotations
@inline()

Related Doc: package xitrum

abstract class OptVar[+A] extends AnyRef

Instance Constructors

new OptVar()(implicit m: Manifest[A])

Type Members

class WithFilter extends AnyRef

Abstract Value Members

abstract def getAll(implicit action: Action): Map[String, Any]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def collect[B](pf: PartialFunction[A, B])(implicit action: Action): Option[B]

final def contains[A1 >: A](elem: A1)(implicit action: Action): Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def exists(p: (A) ⇒ Boolean)(implicit action: Action): Boolean

final def filter(p: (A) ⇒ Boolean)(implicit action: Action): Option[A]

final def filterNot(p: (A) ⇒ Boolean)(implicit action: Action): Option[A]

def finalize(): Unit

final def flatMap[B](f: (A) ⇒ Option[B])(implicit action: Action): Option[B]

def flatten[B](implicit ev: <:<[A, Option[B]], action: Action): Option[B]

final def fold[B](ifEmpty: ⇒ B)(f: (A) ⇒ B)(implicit action: Action): B

final def forall(p: (A) ⇒ Boolean)(implicit action: Action): Boolean

final def foreach[U](f: (A) ⇒ U)(implicit action: Action): Unit

def get(implicit action: Action): A

final def getClass(): Class[_]

final def getOrElse[B >: A](default: ⇒ B)(implicit action: Action): B

def hashCode(): Int

def isDefined(implicit action: Action): Boolean

def isEmpty(implicit action: Action): Boolean

final def isInstanceOf[T0]: Boolean

def iterator(implicit action: Action): Iterator[A]

val key: String

final def map[B](f: (A) ⇒ B)(implicit action: Action): Option[B]

final def ne(arg0: AnyRef): Boolean

final def nonEmpty(implicit action: Action): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def orElse[B >: A](alternative: ⇒ Option[B])(implicit action: Action): Option[B]

final def orNull[A1 >: A](implicit ev: <:<[Null, A1], action: Action): A1

def remove()(implicit action: Action): Option[A]

def set[B >: A](value: B)(implicit action: Action): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

final def toLeft[X](right: ⇒ X)(implicit action: Action): Product with Serializable with Either[A, X]

def toList(implicit action: Action): List[A]

def toOption(implicit action: Action): Option[A]

final def toRight[X](left: ⇒ X)(implicit action: Action): Product with Serializable with Either[X, A]

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def withFilter(p: (A) ⇒ Boolean)(implicit action: Action): WithFilter

Inherited from AnyRef

Inherited from Any

Ungrouped