Property

org.specs2.control.Property
See theProperty companion object
case class Property[T](value: () => Option[T], evaluated: Boolean, evaluatedValue: Option[T])(using x$4: CanEqual[T, T])

This class represents values which are evaluated lazily and which may even be missing.

It has Option-like function and can be also converted to an Either object

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def apply(newValue: => T): Property[T]

alias for update

alias for update

Attributes

override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an 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 Any 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 usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

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

Definition Classes
Equals -> Any
def filter(p: T => Boolean): Property[T]

return the property with the value being filtered according to a predicate

return the property with the value being filtered according to a predicate

Attributes

def flatMap[U](f: T => Option[U])(using CanEqual[U, U]): Property[U]

option-like flatMap

option-like flatMap

Attributes

def foreach(f: T => Unit): Unit

option-like foreach

option-like foreach

Attributes

def getOrElse[U >: T](other: U)(using CanEqual[U, U]): U

option-like getOrElse

option-like getOrElse

Attributes

override def hashCode: Int

Calculate a hash code value for the object.

Calculate 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.

Attributes

Returns:

the hash code value for this object.

Definition Classes
Any
def isDefined: Boolean

option-like isDefined

option-like isDefined

Attributes

def isEmpty: Boolean

option-like isEmpty

option-like isEmpty

Attributes

def iterator: Iterator[T]

Attributes

Returns:

an iterator containing the value if present

def map[U](f: T => U)(using CanEqual[U, U]): Property[U]

option-like map

option-like map

Attributes

def optionalValue: Option[T]

Attributes

Returns:

the option(value)

def orElse[U >: T](other: => Property[U])(using CanEqual[U, U]): Property[U]

option-like orElse

option-like orElse

Attributes

def setValue(init: => T): Unit

change the value and return Unit

change the value and return Unit

Attributes

def toLeft[R](right: R): Either[T, R]

option-like toLeft

option-like toLeft

Attributes

def toList: List[T]

to a list

to a list

Attributes

def toOption: Option[T]

alias for optionalValue

alias for optionalValue

Attributes

def toRight[L](left: L): Either[L, T]

option-like toRight

option-like toRight

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Any
def update(newValue: => T): Property[T]

update the value

update the value

Attributes

def updateValue(init: => Option[T]): Property[T]

change the value

change the value

Attributes

def withValue(init: => T): Property[T]

change the value

change the value

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product