Boolean

Common
JVM
JS
Native
1.0

Represents a value which is either true or false . On the JVM, non-nullable values of this type are represented as values of the primitive type boolean .

Functions

Common
JVM
JS
Native
1.0

and

Performs a logical and operation between this Boolean and the other one. Unlike the && operator, this function does not perform short-circuit evaluation. Both this and other will always be evaluated.

infix fun and ( other : Boolean ) : Boolean
Common
JVM
JS
Native
1.0

compareTo

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other , or a positive number if it's greater than other .

fun compareTo ( other : Boolean ) : Int

equals

Native
1.3
fun equals ( other : Boolean ) : Boolean
Common
JVM
JS
Native
1.0

Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:

fun equals ( other : Any ? ) : Boolean
Native
1.3

hashCode

Returns a hash code value for the object. The general contract of hashCode is:

fun hashCode ( ) : Int
Common
JVM
JS
Native
1.0

not

Returns the inverse of this boolean.

operator fun not ( ) : Boolean
Common
JVM
JS
Native
1.0

or

Performs a logical or operation between this Boolean and the other one. Unlike the || operator, this function does not perform short-circuit evaluation. Both this and other will always be evaluated.

infix fun or ( other : Boolean ) : Boolean
Common
JVM
JS
Native
1.0

toString

Returns a string representation of the object.

fun toString ( ) : String
Common
JVM
JS
Native
1.0

xor

Performs a logical xor operation between this Boolean and the other one.

infix fun xor ( other : Boolean ) : Boolean

Extension Functions

Common
JVM
JS
Native
1.0

coerceAtLeast

Ensures that this value is not less than the specified minimumValue .

fun < T : Comparable < T > > T . coerceAtLeast ( minimumValue : T ) : T
Common
JVM
JS
Native
1.0

coerceAtMost

Ensures that this value is not greater than the specified maximumValue .

fun < T : Comparable < T > > T . coerceAtMost ( maximumValue : T ) : T
Common
JVM
JS
Native
1.0

coerceIn

Ensures that this value lies in the specified range minimumValue .. maximumValue .

fun < T : Comparable < T > > T . coerceIn (
minimumValue : T ? ,
maximumValue : T ?
) : T

Ensures that this value lies in the specified range .

fun < T : Comparable < T > > T . coerceIn (
range : ClosedFloatingPointRange < T >
) : T
fun < T : Comparable < T > > T . coerceIn ( range : ClosedRange < T > ) : T
Common
JVM
JS
Native
1.6

compareTo

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other , or a positive number if it's greater than other .

infix fun < T > Comparable < T > . compareTo ( other : T ) : Int
Common
JVM
JS
Native
1.0

rangeTo

Creates a range from this Comparable value to the specified that value.

operator fun < T : Comparable < T > > T . rangeTo (
that : T
) : ClosedRange < T >
Common
JVM
JS
Native
1.9

rangeUntil

Creates an open-ended range from this Comparable value to the specified that value.

operator fun < T : Comparable < T > > T . rangeUntil (
that : T
) : OpenEndRange < T >
Native
1.3

toByte

fun Boolean . toByte ( ) : Byte