Packages

abstract final class Boolean extends AnyVal

Boolean (equivalent to Java's boolean primitive type) is a subtype of scala.AnyVal. Instances of Boolean are not represented by an object in the underlying runtime system.

There is an implicit conversion from scala.Boolean => scala.runtime.RichBoolean which provides useful non-primitive operations.

Source
Boolean.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Boolean
  2. AnyVal
  3. Any
Implicitly
  1. by boolean2Boolean
  2. by booleanWrapper
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def !=(x: Boolean): Boolean

    Compares two Boolean expressions and returns true if they evaluate to a different value.

    Compares two Boolean expressions and returns true if they evaluate to a different value.

    a != b returns true if and only if

    • a is true and b is false or
    • a is false and b is true.
  2. abstract def &(x: Boolean): Boolean

    Compares two Boolean expressions and returns true if both of them evaluate to true.

    Compares two Boolean expressions and returns true if both of them evaluate to true.

    a & b returns true if and only if

    • a and b are true.
    Note

    This method evaluates both a and b, even if the result is already determined after evaluating a.

  3. abstract def &&(x: Boolean): Boolean

    Compares two Boolean expressions and returns true if both of them evaluate to true.

    Compares two Boolean expressions and returns true if both of them evaluate to true.

    a && b returns true if and only if

    • a and b are true.
    Note

    This method uses 'short-circuit' evaluation and behaves as if it was declared as def &&(x: => Boolean): Boolean. If a evaluates to false, false is returned without evaluating b.

  4. abstract def ==(x: Boolean): Boolean

    Compares two Boolean expressions and returns true if they evaluate to the same value.

    Compares two Boolean expressions and returns true if they evaluate to the same value.

    a == b returns true if and only if

    • a and b are true or
    • a and b are false.
  5. abstract def ^(x: Boolean): Boolean

    Compares two Boolean expressions and returns true if they evaluate to a different value.

    Compares two Boolean expressions and returns true if they evaluate to a different value.

    a ^ b returns true if and only if

    • a is true and b is false or
    • a is false and b is true.
  6. abstract def unary_!: Boolean

    Negates a Boolean expression.

    Negates a Boolean expression.

    - !a results in false if and only if a evaluates to true and - !a results in true if and only if a evaluates to false.

    returns

    the negated expression

  7. abstract def |(x: Boolean): Boolean

    Compares two Boolean expressions and returns true if one or both of them evaluate to true.

    Compares two Boolean expressions and returns true if one or both of them evaluate to true.

    a | b returns true if and only if

    • a is true or
    • b is true or
    • a and b are true.
    Note

    This method evaluates both a and b, even if the result is already determined after evaluating a.

  8. abstract def ||(x: Boolean): Boolean

    Compares two Boolean expressions and returns true if one or both of them evaluate to true.

    Compares two Boolean expressions and returns true if one or both of them evaluate to true.

    a || b returns true if and only if

    • a is true or
    • b is true or
    • a and b are true.
    Note

    This method uses 'short-circuit' evaluation and behaves as if it was declared as def ||(x: => Boolean): Boolean. If a evaluates to true, true is returned without evaluating b.

Concrete Value Members

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

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  2. final def ##: Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Boolean toany2stringadd[Boolean] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Boolean, B)
    Implicit
    This member is added by an implicit conversion from Boolean toArrowAssoc[Boolean] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def <(that: Boolean): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Definition Classes
    Ordered
  6. def <=(that: Boolean): Boolean

    Returns true if this is less than or equal to that.

    Returns true if this is less than or equal to that.

    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Definition Classes
    Ordered
  7. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

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

    Definition Classes
    Any
  8. def >(that: Boolean): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Definition Classes
    Ordered
  9. def >=(that: Boolean): Boolean

    Returns true if this is greater than or equal to that.

    Returns true if this is greater than or equal to that.

    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Definition Classes
    Ordered
  10. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    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 expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(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 type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  11. def booleanValue(): Boolean
    Implicit
    This member is added by an implicit conversion from Boolean tojava.lang.Boolean performed by method boolean2Boolean in scala.Predef.
    Definition Classes
    Boolean
  12. def compare(y: Boolean): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implement this method to determine how instances of A will be sorted.

    Returns x where:

    • x < 0 when this < that
    • x == 0 when this == that
    • x > 0 when this > that
    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Definition Classes
    OrderedProxy → Ordered
  13. def compareTo(arg0: java.lang.Boolean): Int
    Implicit
    This member is added by an implicit conversion from Boolean tojava.lang.Boolean performed by method boolean2Boolean in scala.Predef.
    Definition Classes
    Boolean → Comparable
  14. def compareTo(that: Boolean): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Definition Classes
    Ordered → Comparable
  15. def ensuring(cond: (Boolean) => Boolean, msg: => Any): Boolean
    Implicit
    This member is added by an implicit conversion from Boolean toEnsuring[Boolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (Boolean) => Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from Boolean toEnsuring[Boolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): Boolean
    Implicit
    This member is added by an implicit conversion from Boolean toEnsuring[Boolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from Boolean toEnsuring[Boolean] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def equals(arg0: 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)).

    returns

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

    Definition Classes
    Any
  20. def getClass(): Class[Boolean]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

    a class object corresponding to the runtime type of the receiver.

    Definition Classes
    BooleanAnyValAny
  21. 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.

    returns

    the hash code value for this object.

    Definition Classes
    Any
  22. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Depending on what T0 is, the test is done in one of the below ways:

    • T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
    • T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
    • T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
    • T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
    • T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
    • T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

    This is exactly equivalent to the type pattern _: T0

    returns

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

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  23. val self: Boolean
    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Definition Classes
    RichBoolean → TypedProxy
  24. 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
    Any

Shadowed Implicit Value Members

  1. def equals(arg0: AnyRef): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

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

    Implicit
    This member is added by an implicit conversion from Boolean tojava.lang.Boolean performed by method boolean2Boolean in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (boolean: java.lang.Boolean).equals(arg0)
    Definition Classes
    Boolean → AnyRef → Any
  2. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Implicit
    This member is added by an implicit conversion from Boolean tojava.lang.Boolean performed by method boolean2Boolean in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (boolean: java.lang.Boolean).hashCode()
    Definition Classes
    Boolean → AnyRef → Any
  3. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Implicit
    This member is added by an implicit conversion from Boolean tojava.lang.Boolean performed by method boolean2Boolean in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (boolean: java.lang.Boolean).toString()
    Definition Classes
    Boolean → AnyRef → Any
  4. 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.

    Implicit
    This member is added by an implicit conversion from Boolean toRichBoolean performed by method booleanWrapper in scala.LowPriorityImplicits.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (boolean: RichBoolean).toString()
    Definition Classes
    ProxyAny

Deprecated Value Members

  1. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit
    This member is added by an implicit conversion from Boolean toStringFormat[Boolean] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (Boolean, B)
    Implicit
    This member is added by an implicit conversion from Boolean toArrowAssoc[Boolean] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion boolean2Boolean fromBoolean to java.lang.Boolean

Inherited by implicit conversion booleanWrapper fromBoolean to RichBoolean

Inherited by implicit conversion any2stringadd fromBoolean to any2stringadd[Boolean]

Inherited by implicit conversion StringFormat fromBoolean to StringFormat[Boolean]

Inherited by implicit conversion Ensuring fromBoolean to Ensuring[Boolean]

Inherited by implicit conversion ArrowAssoc fromBoolean to ArrowAssoc[Boolean]

Ungrouped