trait BooleanProp extends Prop[Boolean]
- Alphabetic
- By Inheritance
- BooleanProp
- Prop
- AnyRef
- Any
- by booleanPropAsBoolean
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
clear(): Unit
Removes the property from the underlying map.
Removes the property from the underlying map.
- Definition Classes
- Prop
-
abstract
def
disable(): Unit
Alter this property so that
value
will be false. -
abstract
def
enable(): Unit
Alter this property so that
value
will be true. -
abstract
def
get: String
Gets the current string value if any.
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.
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".
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.
Some(value) if the property is set, None otherwise.
- Definition Classes
- Prop
-
abstract
def
set(newValue: String): String
Sets the property.
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.
Sets the property with a value of the represented type.
- Definition Classes
- Prop
-
abstract
def
toggle(): Unit
Toggle the property between enabled and disabled states.
-
abstract
def
value: Boolean
The semantics of value are determined at Prop creation.
The semantics of value are determined at Prop creation. See methods
valueIsTrue
andkeyExists
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.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.
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 andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- 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.Compares two Boolean expressions and returns
true
if both of them evaluate to true.a & b
returnstrue
if and only ifa
andb
aretrue
.
- 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.Compares two Boolean expressions and returns
true
if both of them evaluate to true.a && b
returnstrue
if and only ifa
andb
aretrue
.
- 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 toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (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.Compares two Boolean expressions and returns
true
if they evaluate to a different value.a ^ b
returns
trueif and only if
a
istrue
andb
isfalse
ora
isfalse
andb
istrue
.
- 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
.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 aClassCastException
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 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.
-
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
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
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 betweenfinalize
and non-local returns and exceptions, are all platform dependent. -
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 forString.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.
-
def
hashCode(): Int
The hashCode method for reference types.
-
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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)
.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.
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.
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.
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.
Negates a Boolean expression.
-
!a
results infalse
if and only ifa
evaluates totrue
and -!a
results intrue
if and only ifa
evaluates tofalse
.- 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.Compares two Boolean expressions and returns
true
if one or both of them evaluate to true.a | b
returnstrue
if and only ifa
istrue
orb
istrue
ora
andb
aretrue
.
- 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.Compares two Boolean expressions and returns
true
if one or both of them evaluate to true.a || b
returnstrue
if and only ifa
istrue
orb
istrue
ora
andb
aretrue
.
- 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.Compares two Boolean expressions and returns
true
if they evaluate to a different value.a != b
returnstrue
if and only ifa
istrue
andb
isfalse
ora
isfalse
andb
istrue
.
- 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.Compares two Boolean expressions and returns
true
if they evaluate to the same value.a == b
returnstrue
if and only ifa
andb
aretrue
ora
andb
arefalse
.
- 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
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.collection.parallel.immutable
- Immutable, parallel data-structures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
- Mutable, parallel data-structures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.