kotlin.ByteArray
ByteArray
class ByteArray
An array of bytes. When targeting the JVM, instances of this class are represented as byte[]
.
Constructors
ByteArray(size: Int, init: (Int) -> Byte) Creates a new array of the specified size, where each element is calculated by calling the specified init function. The init function returns an array element given its index. ByteArray(size: Int) Creates a new array of the specified size, with all elements initialized to zero. |
Properties
val size: Int Returns the number of elements in the array. |
Functions
operator fun get(index: Int): Byte Returns the array element at the given index. This method can be called using the index operator. | |
operator fun iterator(): ByteIterator Creates an iterator over the elements of the array. | |
operator fun set(index: Int, value: Byte) Sets the element at the given index to the given value. This method can be called using the index operator. |
Inherited Functions
open operator fun equals(other: Any?): Boolean Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements: | |
open fun hashCode(): Int Returns a hash code value for the object. The general contract of hashCode is: | |
open fun toString(): String Returns a string representation of the object. |
Extension Properties
val ByteArray.indices: IntRange Returns the range of valid indices for the array. | |
val ByteArray.lastIndex: Int Returns the last valid index for the array. |
Extension Functions
fun ByteArray.all(predicate: (Byte) -> Boolean): Boolean Returns | |
fun ByteArray.any(): Boolean Returns fun ByteArray.any(predicate: (Byte) -> Boolean): Boolean Returns | |
fun ByteArray.asIterable(): Iterable<Byte> Creates an Iterable instance that wraps the original array returning its elements when being iterated. | |
fun ByteArray.asList(): List<Byte> Returns a List that wraps the original array. | |
fun ByteArray.asSequence(): Sequence<Byte> Creates a Sequence instance that wraps the original array returning its elements when being iterated. | |
fun <K, V> ByteArray.associate( transform: (Byte) -> Pair<K, V> ): Map<K, V> Returns a Map containing key-value pairs provided by transform function applied to elements of the given array. | |
fun <K> ByteArray.associateBy( keySelector: (Byte) -> K ): Map<K, Byte> Returns a Map containing the elements from the given array indexed by the key returned from keySelector function applied to each element. fun <K, V> ByteArray.associateBy( keySelector: (Byte) -> K, valueTransform: (Byte) -> V ): Map<K, V> Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given array. | |
fun <K, M : MutableMap<in K, in Byte>> ByteArray.associateByTo( destination: M, keySelector: (Byte) -> K ): M Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each element of the given array and value is the element itself. fun <K, V, M : MutableMap<in K, in V>> ByteArray.associateByTo( destination: M, keySelector: (Byte) -> K, valueTransform: (Byte) -> V ): M Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to elements of the given array. | |
fun <K, V, M : MutableMap<in K, in V>> ByteArray.associateTo( destination: M, transform: (Byte) -> Pair<K, V> ): M Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each element of the given array. | |
fun ByteArray.average(): Double Returns an average value of elements in the array. | |
fun ByteArray.binarySearch( element: Byte, fromIndex: Int = 0, toIndex: Int = size ): Int Searches the array or the range of the array for the provided element using the binary search algorithm. The array is expected to be sorted, otherwise the result is undefined. | |
operator fun ByteArray.component1(): Byte Returns 1st element from the collection. | |
operator fun ByteArray.component2(): Byte Returns 2nd element from the collection. | |
operator fun ByteArray.component3(): Byte Returns 3rd element from the collection. | |
operator fun ByteArray.component4(): Byte Returns 4th element from the collection. | |
operator fun ByteArray.component5(): Byte Returns 5th element from the collection. | |
operator fun ByteArray.contains(element: Byte): Boolean Returns | |
infix fun ByteArray.contentEquals(other: ByteArray): Boolean Returns | |
fun ByteArray.contentHashCode(): Int Returns a hash code based on the contents of this array as if it is List. | |
fun ByteArray.contentToString(): String Returns a string representation of the contents of the specified array as if it is List. | |
fun ByteArray.copyOf(): ByteArray Returns new array which is a copy of the original array. fun ByteArray.copyOf(newSize: Int): ByteArray Returns new array which is a copy of the original array, resized to the given newSize. | |
fun ByteArray.copyOfRange( fromIndex: Int, toIndex: Int ): ByteArray Returns new array which is a copy of range of original array. | |
fun ByteArray.count(): Int Returns the number of elements in this array. fun ByteArray.count(predicate: (Byte) -> Boolean): Int Returns the number of elements matching the given predicate. | |
fun ByteArray.distinct(): List<Byte> Returns a list containing only distinct elements from the given array. | |
fun <K> ByteArray.distinctBy( selector: (Byte) -> K ): List<Byte> Returns a list containing only elements from the given array having distinct keys returned by the given selector function. | |
fun ByteArray.drop(n: Int): List<Byte> Returns a list containing all elements except first n elements. | |
fun ByteArray.dropLast(n: Int): List<Byte> Returns a list containing all elements except last n elements. | |
fun ByteArray.dropLastWhile( predicate: (Byte) -> Boolean ): List<Byte> Returns a list containing all elements except last elements that satisfy the given predicate. | |
fun ByteArray.dropWhile( predicate: (Byte) -> Boolean ): List<Byte> Returns a list containing all elements except first elements that satisfy the given predicate. | |
fun ByteArray.elementAt(index: Int): Byte Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this array. | |
fun ByteArray.elementAtOrElse( index: Int, defaultValue: (Int) -> Byte ): Byte Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array. | |
fun ByteArray.elementAtOrNull(index: Int): Byte? Returns an element at the given index or | |
fun ByteArray.fill( element: Byte, fromIndex: Int = 0, toIndex: Int = size) Fills original array with the provided value. | |
fun ByteArray.filter( predicate: (Byte) -> Boolean ): List<Byte> Returns a list containing only elements matching the given predicate. | |
fun ByteArray.filterIndexed( predicate: (index: Int, Byte) -> Boolean ): List<Byte> Returns a list containing only elements matching the given predicate. | |
fun <C : MutableCollection<in Byte>> ByteArray.filterIndexedTo( destination: C, predicate: (index: Int, Byte) -> Boolean ): C Appends all elements matching the given predicate to the given destination. | |
fun ByteArray.filterNot( predicate: (Byte) -> Boolean ): List<Byte> Returns a list containing all elements not matching the given predicate. | |
fun <C : MutableCollection<in Byte>> ByteArray.filterNotTo( destination: C, predicate: (Byte) -> Boolean ): C Appends all elements not matching the given predicate to the given destination. | |
fun <C : MutableCollection<in Byte>> ByteArray.filterTo( destination: C, predicate: (Byte) -> Boolean ): C Appends all elements matching the given predicate to the given destination. | |
fun ByteArray.find(predicate: (Byte) -> Boolean): Byte? Returns the first element matching the given predicate, or | |
fun ByteArray.findLast(predicate: (Byte) -> Boolean): Byte? Returns the last element matching the given predicate, or | |
fun ByteArray.first(): Byte Returns first element. fun ByteArray.first(predicate: (Byte) -> Boolean): Byte Returns the first element matching the given predicate. | |
fun ByteArray.firstOrNull(): Byte? Returns the first element, or fun ByteArray.firstOrNull( predicate: (Byte) -> Boolean ): Byte? Returns the first element matching the given predicate, or | |
fun <R> ByteArray.flatMap( transform: (Byte) -> Iterable<R> ): List<R> Returns a single list of all elements yielded from results of transform function being invoked on each element of original array. | |
fun <R, C : MutableCollection<in R>> ByteArray.flatMapTo( destination: C, transform: (Byte) -> Iterable<R> ): C Appends all elements yielded from results of transform function being invoked on each element of original array, to the given destination. | |
fun <R> ByteArray.fold( initial: R, operation: (acc: R, Byte) -> R ): R Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element. | |
fun <R> ByteArray.foldIndexed( initial: R, operation: (index: Int, acc: R, Byte) -> R ): R Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element with its index in the original array. | |
fun <R> ByteArray.foldRight( initial: R, operation: (Byte, acc: R) -> R ): R Accumulates value starting with initial value and applying operation from right to left to each element and current accumulator value. | |
fun <R> ByteArray.foldRightIndexed( initial: R, operation: (index: Int, Byte, acc: R) -> R ): R Accumulates value starting with initial value and applying operation from right to left to each element with its index in the original array and current accumulator value. | |
fun ByteArray.forEach(action: (Byte) -> Unit) Performs the given action on each element. | |
fun ByteArray.forEachIndexed( action: (index: Int, Byte) -> Unit) Performs the given action on each element, providing sequential index with the element. | |
fun ByteArray.getOrElse( index: Int, defaultValue: (Int) -> Byte ): Byte Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array. | |
fun ByteArray.getOrNull(index: Int): Byte? Returns an element at the given index or | |
fun <K> ByteArray.groupBy( keySelector: (Byte) -> K ): Map<K, List<Byte>> Groups elements of the original array by the key returned by the given keySelector function applied to each element and returns a map where each group key is associated with a list of corresponding elements. fun <K, V> ByteArray.groupBy( keySelector: (Byte) -> K, valueTransform: (Byte) -> V ): Map<K, List<V>> Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and returns a map where each group key is associated with a list of corresponding values. | |
fun <K, M : MutableMap<in K, MutableList<Byte>>> ByteArray.groupByTo( destination: M, keySelector: (Byte) -> K ): M Groups elements of the original array by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements. fun <K, V, M : MutableMap<in K, MutableList<V>>> ByteArray.groupByTo( destination: M, keySelector: (Byte) -> K, valueTransform: (Byte) -> V ): M Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and puts to the destination map each group key associated with a list of corresponding values. | |
fun ByteArray.indexOf(element: Byte): Int Returns first index of element, or -1 if the array does not contain element. | |
fun ByteArray.indexOfFirst(predicate: (Byte) -> Boolean): Int Returns index of the first element matching the given predicate, or -1 if the array does not contain such element. | |
fun ByteArray.indexOfLast(predicate: (Byte) -> Boolean): Int Returns index of the last element matching the given predicate, or -1 if the array does not contain such element. | |
fun ByteArray.inputStream(): ByteArrayInputStream Creates an input stream for reading data from this byte array. fun ByteArray.inputStream( offset: Int, length: Int ): ByteArrayInputStream Creates an input stream for reading data from the specified portion of this byte array. | |
infix fun ByteArray.intersect( other: Iterable<Byte> ): Set<Byte> Returns a set containing all elements that are contained by both this set and the specified collection. | |
fun ByteArray.isEmpty(): Boolean Returns | |
fun ByteArray.isNotEmpty(): Boolean Returns | |
fun <A : Appendable> ByteArray.joinTo( buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Byte) -> CharSequence = null ): A Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied. | |
fun ByteArray.joinToString( separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (Byte) -> CharSequence = null ): String Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied. | |
fun ByteArray.last(): Byte Returns the last element. fun ByteArray.last(predicate: (Byte) -> Boolean): Byte Returns the last element matching the given predicate. | |
fun ByteArray.lastIndexOf(element: Byte): Int Returns last index of element, or -1 if the array does not contain element. | |
fun ByteArray.lastOrNull(): Byte? Returns the last element, or fun ByteArray.lastOrNull(predicate: (Byte) -> Boolean): Byte? Returns the last element matching the given predicate, or | |
fun <R> ByteArray.map(transform: (Byte) -> R): List<R> Returns a list containing the results of applying the given transform function to each element in the original array. | |
fun <R> ByteArray.mapIndexed( transform: (index: Int, Byte) -> R ): List<R> Returns a list containing the results of applying the given transform function to each element and its index in the original array. | |
fun <R, C : MutableCollection<in R>> ByteArray.mapIndexedTo( destination: C, transform: (index: Int, Byte) -> R ): C Applies the given transform function to each element and its index in the original array and appends the results to the given destination. | |
fun <R, C : MutableCollection<in R>> ByteArray.mapTo( destination: C, transform: (Byte) -> R ): C Applies the given transform function to each element of the original array and appends the results to the given destination. | |
fun ByteArray.max(): Byte? Returns the largest element or | |
fun <R : Comparable<R>> ByteArray.maxBy( selector: (Byte) -> R ): Byte? Returns the first element yielding the largest value of the given function or | |
fun ByteArray.maxWith(comparator: Comparator<in Byte>): Byte? fun ByteArray.maxWith(comparator: Comparator<in Byte>): Byte? Returns the first element having the largest value according to the provided comparator or | |
fun ByteArray.min(): Byte? Returns the smallest element or | |
fun <R : Comparable<R>> ByteArray.minBy( selector: (Byte) -> R ): Byte? Returns the first element yielding the smallest value of the given function or | |
fun ByteArray.minWith(comparator: Comparator<in Byte>): Byte? fun ByteArray.minWith(comparator: Comparator<in Byte>): Byte? Returns the first element having the smallest value according to the provided comparator or | |
fun ByteArray.none(): Boolean Returns fun ByteArray.none(predicate: (Byte) -> Boolean): Boolean Returns | |
fun ByteArray.partition( predicate: (Byte) -> Boolean ): Pair<List<Byte>, List<Byte>> Splits the original array into pair of lists, where first list contains elements for which predicate yielded | |
operator fun ByteArray.plus(element: Byte): ByteArray Returns an array containing all elements of the original array and then the given element. operator fun ByteArray.plus( elements: Collection<Byte> ): ByteArray Returns an array containing all elements of the original array and then all elements of the given elements collection. operator fun ByteArray.plus(elements: ByteArray): ByteArray Returns an array containing all elements of the original array and then all elements of the given elements array. | |
fun ByteArray.reduce( operation: (acc: Byte, Byte) -> Byte ): Byte Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. | |
fun ByteArray.reduceIndexed( operation: (index: Int, acc: Byte, Byte) -> Byte ): Byte Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element with its index in the original array. | |
fun ByteArray.reduceRight( operation: (Byte, acc: Byte) -> Byte ): Byte Accumulates value starting with last element and applying operation from right to left to each element and current accumulator value. | |
fun ByteArray.reduceRightIndexed( operation: (index: Int, Byte, acc: Byte) -> Byte ): Byte Accumulates value starting with last element and applying operation from right to left to each element with its index in the original array and current accumulator value. | |
fun ByteArray.reverse() Reverses elements in the array in-place. | |
fun ByteArray.reversed(): List<Byte> Returns a list with elements in reversed order. | |
fun ByteArray.reversedArray(): ByteArray Returns an array with elements of this array in reversed order. | |
fun ByteArray.single(): Byte Returns the single element, or throws an exception if the array is empty or has more than one element. fun ByteArray.single(predicate: (Byte) -> Boolean): Byte Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element. | |
fun ByteArray.singleOrNull(): Byte? Returns single element, or fun ByteArray.singleOrNull( predicate: (Byte) -> Boolean ): Byte? Returns the single element matching the given predicate, or | |
fun ByteArray.slice(indices: IntRange): List<Byte> Returns a list containing elements at indices in the specified indices range. fun ByteArray.slice(indices: Iterable<Int>): List<Byte> Returns a list containing elements at specified indices. | |
fun ByteArray.sliceArray(indices: Collection<Int>): ByteArray Returns an array containing elements of this array at specified indices. fun ByteArray.sliceArray(indices: IntRange): ByteArray Returns a list containing elements at indices in the specified indices range. | |
fun ByteArray.sort() Sorts the array in-place. fun ByteArray.sort(fromIndex: Int = 0, toIndex: Int = size) Sorts a range in the array in-place. fun ByteArray.sort(comparison: (a: Byte, b: Byte) -> Int) Sorts the array in-place according to the order specified by the given comparison function. | |
fun ByteArray.sortDescending() Sorts elements in the array in-place descending according to their natural sort order. | |
fun ByteArray.sorted(): List<Byte> Returns a list of all elements sorted according to their natural sort order. | |
fun ByteArray.sortedArray(): ByteArray Returns an array with all elements of this array sorted according to their natural sort order. | |
fun ByteArray.sortedArrayDescending(): ByteArray Returns an array with all elements of this array sorted descending according to their natural sort order. | |
fun <R : Comparable<R>> ByteArray.sortedBy( selector: (Byte) -> R? ): List<Byte> Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function. | |
fun <R : Comparable<R>> ByteArray.sortedByDescending( selector: (Byte) -> R? ): List<Byte> Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function. | |
fun ByteArray.sortedDescending(): List<Byte> Returns a list of all elements sorted descending according to their natural sort order. | |
fun ByteArray.sortedWith( comparator: Comparator<in Byte> ): List<Byte> fun ByteArray.sortedWith( comparator: Comparator<in Byte> ): List<Byte> Returns a list of all elements sorted according to the specified comparator. | |
infix fun ByteArray.subtract( other: Iterable<Byte> ): Set<Byte> Returns a set containing all elements that are contained by this array and not contained by the specified collection. | |
fun ByteArray.sum(): Int Returns the sum of all elements in the array. | |
fun ByteArray.sumBy(selector: (Byte) -> Int): Int Returns the sum of all values produced by selector function applied to each element in the array. | |
fun ByteArray.sumByDouble(selector: (Byte) -> Double): Double Returns the sum of all values produced by selector function applied to each element in the array. | |
fun ByteArray.take(n: Int): List<Byte> Returns a list containing first n elements. | |
fun ByteArray.takeLast(n: Int): List<Byte> Returns a list containing last n elements. | |
fun ByteArray.takeLastWhile( predicate: (Byte) -> Boolean ): List<Byte> Returns a list containing last elements satisfying the given predicate. | |
fun ByteArray.takeWhile( predicate: (Byte) -> Boolean ): List<Byte> Returns a list containing first elements satisfying the given predicate. | |
fun <C : MutableCollection<in Byte>> ByteArray.toCollection( destination: C ): C Appends all elements to the given destination collection. | |
fun ByteArray.toHashSet(): HashSet<Byte> Returns a HashSet of all elements. | |
fun ByteArray.toList(): List<Byte> Returns a List containing all elements. | |
fun ByteArray.toMutableList(): MutableList<Byte> Returns a MutableList filled with all elements of this array. | |
fun ByteArray.toMutableSet(): MutableSet<Byte> Returns a mutable set containing all distinct elements from the given array. | |
fun ByteArray.toSet(): Set<Byte> Returns a Set of all elements. | |
fun ByteArray.toSortedSet(): SortedSet<Byte> Returns a SortedSet of all elements. | |
fun ByteArray.toString(charset: Charset): String Converts the contents of this byte array to a string using the specified charset. | |
fun ByteArray.toTypedArray(): Array<Byte> Returns a typed object array containing all of the elements of this primitive array. | |
infix fun ByteArray.union(other: Iterable<Byte>): Set<Byte> Returns a set containing all distinct elements from both collections. | |
fun ByteArray.withIndex(): Iterable<IndexedValue<Byte>> Returns a lazy Iterable of IndexedValue for each element of the original array. | |
infix fun <R> any_array<R>.zip( other: Array<out R> ): List<Pair<Byte, R>> Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection. fun <R, V> any_array<R>.zip( other: Array<out R>, transform: (a: Byte, b: R) -> V ): List<V> Returns a list of values built from elements of both collections with same indexes using provided transform. List has length of shortest collection. |
© 2010–2017 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/