Trait scala.sys.BooleanProp
Companion object BooleanProp
trait BooleanProp extends Prop[Boolean]
Abstract Value Members
abstract def clear(): Unit
Removes the property from the underlying map.
- Definition Classes
- Prop
abstract def disable(): Unit
abstract def enable(): Unit
abstract def get: String
Gets the current string value if any. Will not return null: use isSet
to test for existence.
- returns
the current string value if any, else the empty string
- Definition Classes
- Prop
abstract def isSet: Boolean
True if the key exists in the properties map. Note that this is not sufficient for a Boolean property to be considered true.
- returns
whether the map contains the key
- Definition Classes
- Prop
abstract def key: String
The full name of the property, e.g., "java.awt.headless".
- Definition Classes
- Prop
abstract def option: Option[Boolean]
Some(value) if the property is set, None otherwise.
- Definition Classes
- Prop
abstract def set(newValue: String): String
Sets the property.
- newValue
the new string value
- returns
the old value, or null if it was unset.
- Definition Classes
- Prop
abstract def setValue[T1 >: Boolean](value: T1): Boolean
Sets the property with a value of the represented type.
- Definition Classes
- Prop
abstract def toggle(): Unit
abstract def value: Boolean
The semantics of value are determined at Prop creation. See methods valueIsTrue
and keyExists
in object BooleanProp for examples.
- returns
true if the current String is considered true, false otherwise
- Definition Classes
- BooleanProp → Prop
abstract def zero: Boolean
A value of type T
for use when the property is unset. The default implementation delivers null for reference types and 0/0.0/false for non-reference types.
- Attributes
- protected
- Definition Classes
- Prop
Concrete Value Members
final def !=(arg0: Any): Boolean
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
final def ##(): Int
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
- AnyRef → Any
def &(x: Boolean): Boolean
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
. - Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- Definition Classes
- Boolean
- Note
This method evaluates both
a
andb
, even if the result is already determined after evaluatinga
.
def &&(x: Boolean): Boolean
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
. - Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- Definition Classes
- Boolean
- Note
This method uses 'short-circuit' evaluation and behaves as if it was declared as
def &&(x: => Boolean): Boolean
. Ifa
evaluates tofalse
,false
is returned without evaluatingb
.
def +(other: String): String
- Implicit
- This member is added by an implicit conversion from BooleanProp to any2stringadd[BooleanProp] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
def ->[B](y: B): (BooleanProp, B)
- Implicit
- This member is added by an implicit conversion from BooleanProp to ArrowAssoc[BooleanProp] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
final def ==(arg0: Any): Boolean
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
- AnyRef → Any
def ^(x: Boolean): Boolean
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
. - Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- Definition Classes
- Boolean
final def asInstanceOf[T0]: 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 typeT0
.
def clone(): AnyRef
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
- returns
a copy of the receiver object.
def ensuring(cond: (BooleanProp) ⇒ Boolean, msg: ⇒ Any): BooleanProp
- Implicit
- This member is added by an implicit conversion from BooleanProp to Ensuring[BooleanProp] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (BooleanProp) ⇒ Boolean): BooleanProp
- Implicit
- This member is added by an implicit conversion from BooleanProp to Ensuring[BooleanProp] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): BooleanProp
- Implicit
- This member is added by an implicit conversion from BooleanProp to Ensuring[BooleanProp] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): BooleanProp
- Implicit
- This member is added by an implicit conversion from BooleanProp to Ensuring[BooleanProp] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that
) is a reference to the receiver object (this
).
The eq
method implements an equivalence relation on non-null instances of AnyRef
, and has three additional 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
).
- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
def equals(arg0: Any): Boolean
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.
- Definition Classes
- AnyRef → Any
def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize
method is invoked, as well as the interaction between finalize
and non-local returns and exceptions, are all platform dependent.
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
def formatted(fmtstr: String): 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 BooleanProp to StringFormat[BooleanProp] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
final def getClass(): Class[_]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def hashCode(): Int
The hashCode method for reference types. See hashCode in scala.Any.
- returns
the hash code value for this object.
final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is T0
.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.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 specified type.
- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that)
.
- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
def toString(): String
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.
- Definition Classes
- AnyRef → Any
def unary_!: Boolean
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
- Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- Definition Classes
- Boolean
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
def |(x: Boolean): Boolean
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
. - Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- Definition Classes
- Boolean
- Note
This method evaluates both
a
andb
, even if the result is already determined after evaluatinga
.
def ||(x: Boolean): Boolean
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
. - Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- Definition Classes
- Boolean
- Note
This method uses 'short-circuit' evaluation and behaves as if it was declared as
def ||(x: => Boolean): Boolean
. Ifa
evaluates totrue
,true
is returned without evaluatingb
.
def →[B](y: B): (BooleanProp, B)
- Implicit
- This member is added by an implicit conversion from BooleanProp to ArrowAssoc[BooleanProp] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
def !=(x: Boolean): Boolean
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
. - Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- 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:(booleanProp: Boolean).!=(x)
- Definition Classes
- Boolean
def ==(x: Boolean): Boolean
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
. - Implicit
- This member is added by an implicit conversion from BooleanProp to Boolean performed by method booleanPropAsBoolean in scala.sys.BooleanProp.
- 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:(booleanProp: Boolean).==(x)
- Definition Classes
- Boolean
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/sys/BooleanProp.html
A few additional conveniences for Boolean properties.