Byte

kotlin-stdlib / kotlin / Byte
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.3) 
class Byte : Number, Comparable<Byte>
For Common, JVM, JS

Represents a 8-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type byte.

For Native

Represents a 8-bit signed integer.

Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

compareTo

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

operator fun compareTo(other: Byte): Int
operator fun compareTo(other: Short): Int
operator fun compareTo(other: Int): Int
operator fun compareTo(other: Long): Int
operator fun compareTo(other: Float): Int
operator fun compareTo(other: Double): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

dec

Returns this value decremented by one.

operator fun dec(): Byte
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

div

Divides this value by the other value, truncating the result to an integer that is closer to zero.

operator fun div(other: Byte): Int
operator fun div(other: Short): Int
operator fun div(other: Int): Int
operator fun div(other: Long): Long

Divides this value by the other value.

operator fun div(other: Float): Float
operator fun div(other: Double): Double
Platform and version requirements: Native (1.3)

equals

fun equals(other: Byte): Boolean

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

fun equals(other: Any?): Boolean
Platform and version requirements: Native (1.3)

hashCode

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

fun hashCode(): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

inc

Returns this value incremented by one.

operator fun inc(): Byte
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

minus

Subtracts the other value from this value.

operator fun minus(other: Byte): Int
operator fun minus(other: Short): Int
operator fun minus(other: Int): Int
operator fun minus(other: Long): Long
operator fun minus(other: Float): Float
operator fun minus(other: Double): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

plus

Adds the other value to this value.

operator fun plus(other: Byte): Int
operator fun plus(other: Short): Int
operator fun plus(other: Int): Int
operator fun plus(other: Long): Long
operator fun plus(other: Float): Float
operator fun plus(other: Double): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

rangeTo

Creates a range from this value to the specified other value.

operator fun rangeTo(other: Byte): IntRange
operator fun rangeTo(other: Short): IntRange
operator fun rangeTo(other: Int): IntRange
operator fun rangeTo(other: Long): LongRange
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

rem

Calculates the remainder of truncating division of this value by the other value.

operator fun rem(other: Byte): Int
operator fun rem(other: Short): Int
operator fun rem(other: Int): Int
operator fun rem(other: Long): Long
operator fun rem(other: Float): Float
operator fun rem(other: Double): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

times

Multiplies this value by the other value.

operator fun times(other: Byte): Int
operator fun times(other: Short): Int
operator fun times(other: Int): Int
operator fun times(other: Long): Long
operator fun times(other: Float): Float
operator fun times(other: Double): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toByte

Returns this value.

fun toByte(): Byte
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toChar

Converts this Byte value to Char.

fun toChar(): Char
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toDouble

Converts this Byte value to Double.

fun toDouble(): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toFloat

Converts this Byte value to Float.

fun toFloat(): Float
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toInt

Converts this Byte value to Int.

fun toInt(): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toLong

Converts this Byte value to Long.

fun toLong(): Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toShort

Converts this Byte value to Short.

fun toShort(): Short
Platform and version requirements: Native (1.3)

toString

Returns a string representation of the object.

fun toString(): String
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

unaryMinus

Returns the negative of this value.

operator fun unaryMinus(): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

unaryPlus

Returns this value.

operator fun unaryPlus(): Int

Companion Object Properties

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

MAX_VALUE

A constant holding the maximum value an instance of Byte can have.

const val MAX_VALUE: Byte
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

MIN_VALUE

A constant holding the minimum value an instance of Byte can have.

const val MIN_VALUE: Byte
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

SIZE_BITS

The number of bits used to represent an instance of Byte in a binary form.

const val SIZE_BITS: Int
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

SIZE_BYTES

The number of bytes used to represent an instance of Byte in a binary form.

const val SIZE_BYTES: Int

Extension Functions

Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

and

Performs a bitwise AND operation between the two values.

infix fun Byte.and(other: Byte): Byte
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

coerceAtLeast

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

fun Byte.coerceAtLeast(minimumValue: Byte): Byte
fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

coerceAtMost

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

fun Byte.coerceAtMost(maximumValue: Byte): Byte
fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

coerceIn

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

fun Byte.coerceIn(
    minimumValue: Byte, 
    maximumValue: Byte
): Byte
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
Platform and version requirements: JVM (1.6), JS (1.6), 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
Platform and version requirements: Native (1.3)

convert

fun <R : Any> Byte.convert(): R
Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

countLeadingZeroBits

Counts the number of consecutive most significant bits that are zero in the binary representation of this Byte number.

fun Byte.countLeadingZeroBits(): Int
Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

countOneBits

Counts the number of set bits in the binary representation of this Byte number.

fun Byte.countOneBits(): Int
Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

countTrailingZeroBits

Counts the number of consecutive least significant bits that are zero in the binary representation of this Byte number.

fun Byte.countTrailingZeroBits(): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

downTo

Returns a progression from this value down to the specified to value with the step -1.

infix fun Byte.downTo(to: Byte): IntProgression
infix fun Byte.downTo(to: Int): IntProgression
infix fun Byte.downTo(to: Long): LongProgression
infix fun Byte.downTo(to: Short): IntProgression
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

floorDiv

Divides this value by the other value, flooring the result to an integer that is closer to negative infinity.

fun Byte.floorDiv(other: Byte): Int
fun Byte.floorDiv(other: Short): Int
fun Byte.floorDiv(other: Int): Int
fun Byte.floorDiv(other: Long): Long
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

inv

Inverts the bits in this value.

fun Byte.inv(): Byte
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

mod

Calculates the remainder of flooring division of this value by the other value.

fun Byte.mod(other: Byte): Byte
fun Byte.mod(other: Short): Short
fun Byte.mod(other: Int): Int
fun Byte.mod(other: Long): Long
Platform and version requirements: Native (1.3)

narrow

fun <R : Number> Number.narrow(): R
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

or

Performs a bitwise OR operation between the two values.

infix fun Byte.or(other: Byte): Byte
Platform and version requirements: JVM (1.0), JS (1.0), 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>
Platform and version requirements: JVM (1.6), JS (1.6), Native (1.6)

rotateLeft

Rotates the binary representation of this Byte number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

fun Byte.rotateLeft(bitCount: Int): Byte
Platform and version requirements: JVM (1.6), JS (1.6), Native (1.6)

rotateRight

Rotates the binary representation of this Byte number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

fun Byte.rotateRight(bitCount: Int): Byte
Platform and version requirements: Native (1.3)

signExtend

fun <R : Number> Number.signExtend(): R
Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

takeHighestOneBit

Returns a number having a single bit set in the position of the most significant set bit of this Byte number, or zero, if this number is zero.

fun Byte.takeHighestOneBit(): Byte
Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

takeLowestOneBit

Returns a number having a single bit set in the position of the least significant set bit of this Byte number, or zero, if this number is zero.

fun Byte.takeLowestOneBit(): Byte
Platform and version requirements: Native (1.3)

toBoolean

fun Byte.toBoolean(): Boolean
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

toUByte

Converts this Byte value to UByte.

fun Byte.toUByte(): UByte
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

toUInt

Converts this Byte value to UInt.

fun Byte.toUInt(): UInt
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

toULong

Converts this Byte value to ULong.

fun Byte.toULong(): ULong
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

toUShort

Converts this Byte value to UShort.

fun Byte.toUShort(): UShort
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

until

Returns a range from this value up to but excluding the specified to value.

infix fun Byte.until(to: Byte): IntRange
infix fun Byte.until(to: Int): IntRange
infix fun Byte.until(to: Long): LongRange
infix fun Byte.until(to: Short): IntRange
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

xor

Performs a bitwise XOR operation between the two values.

infix fun Byte.xor(other: Byte): Byte

© 2010–2021 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html