azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Standard library documentation updates.

Browse Source
This commit is contained in:
Dmitry Jemerov
2015-02-04 13:53:42 +01:00
parent 6763d61aae
commit 7827bbf64b
41 changed files with 1144 additions and 625 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/src/generated/_Aggregates.kt
+50 -50
View File
@@ -218,7 +218,7 @@ public fun String.any(): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun <T> Array<out T>.any(predicate: (T) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -226,7 +226,7 @@ public inline fun <T> Array<out T>.any(predicate: (T) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun BooleanArray.any(predicate: (Boolean) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -234,7 +234,7 @@ public inline fun BooleanArray.any(predicate: (Boolean) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun ByteArray.any(predicate: (Byte) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -242,7 +242,7 @@ public inline fun ByteArray.any(predicate: (Byte) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun CharArray.any(predicate: (Char) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -250,7 +250,7 @@ public inline fun CharArray.any(predicate: (Char) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun DoubleArray.any(predicate: (Double) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -258,7 +258,7 @@ public inline fun DoubleArray.any(predicate: (Double) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun FloatArray.any(predicate: (Float) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -266,7 +266,7 @@ public inline fun FloatArray.any(predicate: (Float) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun IntArray.any(predicate: (Int) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -274,7 +274,7 @@ public inline fun IntArray.any(predicate: (Int) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun LongArray.any(predicate: (Long) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -282,7 +282,7 @@ public inline fun LongArray.any(predicate: (Long) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun ShortArray.any(predicate: (Short) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -290,7 +290,7 @@ public inline fun ShortArray.any(predicate: (Short) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun <T> Iterable<T>.any(predicate: (T) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -298,7 +298,7 @@ public inline fun <T> Iterable<T>.any(predicate: (T) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun <K, V> Map<K, V>.any(predicate: (Map.Entry<K, V>) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -306,7 +306,7 @@ public inline fun <K, V> Map<K, V>.any(predicate: (Map.Entry<K, V>) -> Boolean):
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun <T> Stream<T>.any(predicate: (T) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -314,7 +314,7 @@ public inline fun <T> Stream<T>.any(predicate: (T) -> Boolean): Boolean {
}
/**
* Returns *true* if any element matches the given *predicate*
* Returns *true* if any element matches the given [predicate]
*/
public inline fun String.any(predicate: (Char) -> Boolean): Boolean {
for (element in this) if (predicate(element)) return true
@@ -424,7 +424,7 @@ public fun String.count(): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun <T> Array<out T>.count(predicate: (T) -> Boolean): Int {
var count = 0
@@ -433,7 +433,7 @@ public inline fun <T> Array<out T>.count(predicate: (T) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun BooleanArray.count(predicate: (Boolean) -> Boolean): Int {
var count = 0
@@ -442,7 +442,7 @@ public inline fun BooleanArray.count(predicate: (Boolean) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun ByteArray.count(predicate: (Byte) -> Boolean): Int {
var count = 0
@@ -451,7 +451,7 @@ public inline fun ByteArray.count(predicate: (Byte) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun CharArray.count(predicate: (Char) -> Boolean): Int {
var count = 0
@@ -460,7 +460,7 @@ public inline fun CharArray.count(predicate: (Char) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun DoubleArray.count(predicate: (Double) -> Boolean): Int {
var count = 0
@@ -469,7 +469,7 @@ public inline fun DoubleArray.count(predicate: (Double) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun FloatArray.count(predicate: (Float) -> Boolean): Int {
var count = 0
@@ -478,7 +478,7 @@ public inline fun FloatArray.count(predicate: (Float) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun IntArray.count(predicate: (Int) -> Boolean): Int {
var count = 0
@@ -487,7 +487,7 @@ public inline fun IntArray.count(predicate: (Int) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun LongArray.count(predicate: (Long) -> Boolean): Int {
var count = 0
@@ -496,7 +496,7 @@ public inline fun LongArray.count(predicate: (Long) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun ShortArray.count(predicate: (Short) -> Boolean): Int {
var count = 0
@@ -505,7 +505,7 @@ public inline fun ShortArray.count(predicate: (Short) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun <T> Iterable<T>.count(predicate: (T) -> Boolean): Int {
var count = 0
@@ -514,7 +514,7 @@ public inline fun <T> Iterable<T>.count(predicate: (T) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun <K, V> Map<K, V>.count(predicate: (Map.Entry<K, V>) -> Boolean): Int {
var count = 0
@@ -523,7 +523,7 @@ public inline fun <K, V> Map<K, V>.count(predicate: (Map.Entry<K, V>) -> Boolean
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun <T> Stream<T>.count(predicate: (T) -> Boolean): Int {
var count = 0
@@ -532,7 +532,7 @@ public inline fun <T> Stream<T>.count(predicate: (T) -> Boolean): Int {
}
/**
* Returns the number of elements matching the given *predicate*
* Returns the number of elements matching the given [predicate]
*/
public inline fun String.count(predicate: (Char) -> Boolean): Int {
var count = 0
@@ -2243,7 +2243,7 @@ public inline fun String.reduceRight(operation: (Char, Char) -> Char): Char {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun <T> Array<out T>.sumBy(transform: (T) -> Int): Int {
var sum: Int = 0
@@ -2254,7 +2254,7 @@ public inline fun <T> Array<out T>.sumBy(transform: (T) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun BooleanArray.sumBy(transform: (Boolean) -> Int): Int {
var sum: Int = 0
@@ -2265,7 +2265,7 @@ public inline fun BooleanArray.sumBy(transform: (Boolean) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun ByteArray.sumBy(transform: (Byte) -> Int): Int {
var sum: Int = 0
@@ -2276,7 +2276,7 @@ public inline fun ByteArray.sumBy(transform: (Byte) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun CharArray.sumBy(transform: (Char) -> Int): Int {
var sum: Int = 0
@@ -2287,7 +2287,7 @@ public inline fun CharArray.sumBy(transform: (Char) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun DoubleArray.sumBy(transform: (Double) -> Int): Int {
var sum: Int = 0
@@ -2298,7 +2298,7 @@ public inline fun DoubleArray.sumBy(transform: (Double) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun FloatArray.sumBy(transform: (Float) -> Int): Int {
var sum: Int = 0
@@ -2309,7 +2309,7 @@ public inline fun FloatArray.sumBy(transform: (Float) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun IntArray.sumBy(transform: (Int) -> Int): Int {
var sum: Int = 0
@@ -2320,7 +2320,7 @@ public inline fun IntArray.sumBy(transform: (Int) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun LongArray.sumBy(transform: (Long) -> Int): Int {
var sum: Int = 0
@@ -2331,7 +2331,7 @@ public inline fun LongArray.sumBy(transform: (Long) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun ShortArray.sumBy(transform: (Short) -> Int): Int {
var sum: Int = 0
@@ -2342,7 +2342,7 @@ public inline fun ShortArray.sumBy(transform: (Short) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun <T> Iterable<T>.sumBy(transform: (T) -> Int): Int {
var sum: Int = 0
@@ -2353,7 +2353,7 @@ public inline fun <T> Iterable<T>.sumBy(transform: (T) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun <T> Stream<T>.sumBy(transform: (T) -> Int): Int {
var sum: Int = 0
@@ -2364,7 +2364,7 @@ public inline fun <T> Stream<T>.sumBy(transform: (T) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from characters in the string
*/
public inline fun String.sumBy(transform: (Char) -> Int): Int {
var sum: Int = 0
@@ -2375,7 +2375,7 @@ public inline fun String.sumBy(transform: (Char) -> Int): Int {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun <T> Array<out T>.sumByDouble(transform: (T) -> Double): Double {
var sum: Double = 0.0
@@ -2386,7 +2386,7 @@ public inline fun <T> Array<out T>.sumByDouble(transform: (T) -> Double): Double
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun BooleanArray.sumByDouble(transform: (Boolean) -> Double): Double {
var sum: Double = 0.0
@@ -2397,7 +2397,7 @@ public inline fun BooleanArray.sumByDouble(transform: (Boolean) -> Double): Doub
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun ByteArray.sumByDouble(transform: (Byte) -> Double): Double {
var sum: Double = 0.0
@@ -2408,7 +2408,7 @@ public inline fun ByteArray.sumByDouble(transform: (Byte) -> Double): Double {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun CharArray.sumByDouble(transform: (Char) -> Double): Double {
var sum: Double = 0.0
@@ -2419,7 +2419,7 @@ public inline fun CharArray.sumByDouble(transform: (Char) -> Double): Double {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun DoubleArray.sumByDouble(transform: (Double) -> Double): Double {
var sum: Double = 0.0
@@ -2430,7 +2430,7 @@ public inline fun DoubleArray.sumByDouble(transform: (Double) -> Double): Double
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun FloatArray.sumByDouble(transform: (Float) -> Double): Double {
var sum: Double = 0.0
@@ -2441,7 +2441,7 @@ public inline fun FloatArray.sumByDouble(transform: (Float) -> Double): Double {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun IntArray.sumByDouble(transform: (Int) -> Double): Double {
var sum: Double = 0.0
@@ -2452,7 +2452,7 @@ public inline fun IntArray.sumByDouble(transform: (Int) -> Double): Double {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun LongArray.sumByDouble(transform: (Long) -> Double): Double {
var sum: Double = 0.0
@@ -2463,7 +2463,7 @@ public inline fun LongArray.sumByDouble(transform: (Long) -> Double): Double {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun ShortArray.sumByDouble(transform: (Short) -> Double): Double {
var sum: Double = 0.0
@@ -2474,7 +2474,7 @@ public inline fun ShortArray.sumByDouble(transform: (Short) -> Double): Double {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun <T> Iterable<T>.sumByDouble(transform: (T) -> Double): Double {
var sum: Double = 0.0
@@ -2485,7 +2485,7 @@ public inline fun <T> Iterable<T>.sumByDouble(transform: (T) -> Double): Double
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from elements in the collection
*/
public inline fun <T> Stream<T>.sumByDouble(transform: (T) -> Double): Double {
var sum: Double = 0.0
@@ -2496,7 +2496,7 @@ public inline fun <T> Stream<T>.sumByDouble(transform: (T) -> Double): Double {
}
/**
* Returns the sum of all values produced by `transform` function from elements in the collection
* Returns the sum of all values produced by [transform] function from characters in the string
*/
public inline fun String.sumByDouble(transform: (Char) -> Double): Double {
var sum: Double = 0.0
libraries/stdlib/src/generated/_Elements.kt
+211 -161
View File
File diff suppressed because it is too large Load Diff
libraries/stdlib/src/generated/_Filtering.kt
+101 -101
View File
@@ -10,7 +10,7 @@ import java.util.*
import java.util.Collections // TODO: it's temporary while we have java.util.Collections in js
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun <T> Array<out T>.drop(n: Int): List<T> {
if (n >= size())
@@ -24,7 +24,7 @@ public fun <T> Array<out T>.drop(n: Int): List<T> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun BooleanArray.drop(n: Int): List<Boolean> {
if (n >= size())
@@ -38,7 +38,7 @@ public fun BooleanArray.drop(n: Int): List<Boolean> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun ByteArray.drop(n: Int): List<Byte> {
if (n >= size())
@@ -52,7 +52,7 @@ public fun ByteArray.drop(n: Int): List<Byte> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun CharArray.drop(n: Int): List<Char> {
if (n >= size())
@@ -66,7 +66,7 @@ public fun CharArray.drop(n: Int): List<Char> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun DoubleArray.drop(n: Int): List<Double> {
if (n >= size())
@@ -80,7 +80,7 @@ public fun DoubleArray.drop(n: Int): List<Double> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun FloatArray.drop(n: Int): List<Float> {
if (n >= size())
@@ -94,7 +94,7 @@ public fun FloatArray.drop(n: Int): List<Float> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun IntArray.drop(n: Int): List<Int> {
if (n >= size())
@@ -108,7 +108,7 @@ public fun IntArray.drop(n: Int): List<Int> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun LongArray.drop(n: Int): List<Long> {
if (n >= size())
@@ -122,7 +122,7 @@ public fun LongArray.drop(n: Int): List<Long> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun ShortArray.drop(n: Int): List<Short> {
if (n >= size())
@@ -136,7 +136,7 @@ public fun ShortArray.drop(n: Int): List<Short> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun <T> Collection<T>.drop(n: Int): List<T> {
if (n >= size())
@@ -150,7 +150,7 @@ public fun <T> Collection<T>.drop(n: Int): List<T> {
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a list containing all elements except first [n] elements
*/
public fun <T> Iterable<T>.drop(n: Int): List<T> {
var count = 0
@@ -162,21 +162,21 @@ public fun <T> Iterable<T>.drop(n: Int): List<T> {
}
/**
* Returns a stream containing all elements except first *n* elements
* Returns a stream containing all elements except first [n] elements
*/
public fun <T> Stream<T>.drop(n: Int): Stream<T> {
return DropStream(this, n)
}
/**
* Returns a list containing all elements except first *n* elements
* Returns a string with the first [n] characters removed
*/
public fun String.drop(n: Int): String {
return substring(Math.min(n, length()))
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun <T> Array<out T>.dropWhile(predicate: (T) -> Boolean): List<T> {
var yielding = false
@@ -192,7 +192,7 @@ public inline fun <T> Array<out T>.dropWhile(predicate: (T) -> Boolean): List<T>
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun BooleanArray.dropWhile(predicate: (Boolean) -> Boolean): List<Boolean> {
var yielding = false
@@ -208,7 +208,7 @@ public inline fun BooleanArray.dropWhile(predicate: (Boolean) -> Boolean): List<
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun ByteArray.dropWhile(predicate: (Byte) -> Boolean): List<Byte> {
var yielding = false
@@ -224,7 +224,7 @@ public inline fun ByteArray.dropWhile(predicate: (Byte) -> Boolean): List<Byte>
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun CharArray.dropWhile(predicate: (Char) -> Boolean): List<Char> {
var yielding = false
@@ -240,7 +240,7 @@ public inline fun CharArray.dropWhile(predicate: (Char) -> Boolean): List<Char>
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun DoubleArray.dropWhile(predicate: (Double) -> Boolean): List<Double> {
var yielding = false
@@ -256,7 +256,7 @@ public inline fun DoubleArray.dropWhile(predicate: (Double) -> Boolean): List<Do
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun FloatArray.dropWhile(predicate: (Float) -> Boolean): List<Float> {
var yielding = false
@@ -272,7 +272,7 @@ public inline fun FloatArray.dropWhile(predicate: (Float) -> Boolean): List<Floa
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun IntArray.dropWhile(predicate: (Int) -> Boolean): List<Int> {
var yielding = false
@@ -288,7 +288,7 @@ public inline fun IntArray.dropWhile(predicate: (Int) -> Boolean): List<Int> {
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun LongArray.dropWhile(predicate: (Long) -> Boolean): List<Long> {
var yielding = false
@@ -304,7 +304,7 @@ public inline fun LongArray.dropWhile(predicate: (Long) -> Boolean): List<Long>
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun ShortArray.dropWhile(predicate: (Short) -> Boolean): List<Short> {
var yielding = false
@@ -320,7 +320,7 @@ public inline fun ShortArray.dropWhile(predicate: (Short) -> Boolean): List<Shor
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a list containing all elements except first elements that satisfy the given [predicate]
*/
public inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T> {
var yielding = false
@@ -336,14 +336,14 @@ public inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T>
}
/**
* Returns a stream containing all elements except first elements that satisfy the given *predicate*
* Returns a stream containing all elements except first elements that satisfy the given [predicate]
*/
public fun <T> Stream<T>.dropWhile(predicate: (T) -> Boolean): Stream<T> {
return DropWhileStream(this, predicate)
}
/**
* Returns a list containing all elements except first elements that satisfy the given *predicate*
* Returns a string containing all characters except first characters that satisfy the given [predicate]
*/
public inline fun String.dropWhile(predicate: (Char) -> Boolean): String {
for (index in 0..length - 1)
@@ -354,168 +354,168 @@ public inline fun String.dropWhile(predicate: (Char) -> Boolean): String {
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun <T> Array<out T>.filter(predicate: (T) -> Boolean): List<T> {
return filterTo(ArrayList<T>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun BooleanArray.filter(predicate: (Boolean) -> Boolean): List<Boolean> {
return filterTo(ArrayList<Boolean>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun ByteArray.filter(predicate: (Byte) -> Boolean): List<Byte> {
return filterTo(ArrayList<Byte>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun CharArray.filter(predicate: (Char) -> Boolean): List<Char> {
return filterTo(ArrayList<Char>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun DoubleArray.filter(predicate: (Double) -> Boolean): List<Double> {
return filterTo(ArrayList<Double>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun FloatArray.filter(predicate: (Float) -> Boolean): List<Float> {
return filterTo(ArrayList<Float>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun IntArray.filter(predicate: (Int) -> Boolean): List<Int> {
return filterTo(ArrayList<Int>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun LongArray.filter(predicate: (Long) -> Boolean): List<Long> {
return filterTo(ArrayList<Long>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun ShortArray.filter(predicate: (Short) -> Boolean): List<Short> {
return filterTo(ArrayList<Short>(), predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a list containing all elements matching the given [predicate]
*/
public inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T> {
return filterTo(ArrayList<T>(), predicate)
}
/**
* Returns a stream containing all elements matching the given *predicate*
* Returns a stream containing all elements matching the given [predicate]
*/
public fun <T> Stream<T>.filter(predicate: (T) -> Boolean): Stream<T> {
return FilteringStream(this, true, predicate)
}
/**
* Returns a list containing all elements matching the given *predicate*
* Returns a string containing only those characters from the original string that match the given [predicate]
*/
public inline fun String.filter(predicate: (Char) -> Boolean): String {
return filterTo(StringBuilder(), predicate).toString()
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun <T> Array<out T>.filterNot(predicate: (T) -> Boolean): List<T> {
return filterNotTo(ArrayList<T>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun BooleanArray.filterNot(predicate: (Boolean) -> Boolean): List<Boolean> {
return filterNotTo(ArrayList<Boolean>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun ByteArray.filterNot(predicate: (Byte) -> Boolean): List<Byte> {
return filterNotTo(ArrayList<Byte>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun CharArray.filterNot(predicate: (Char) -> Boolean): List<Char> {
return filterNotTo(ArrayList<Char>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun DoubleArray.filterNot(predicate: (Double) -> Boolean): List<Double> {
return filterNotTo(ArrayList<Double>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun FloatArray.filterNot(predicate: (Float) -> Boolean): List<Float> {
return filterNotTo(ArrayList<Float>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun IntArray.filterNot(predicate: (Int) -> Boolean): List<Int> {
return filterNotTo(ArrayList<Int>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun LongArray.filterNot(predicate: (Long) -> Boolean): List<Long> {
return filterNotTo(ArrayList<Long>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun ShortArray.filterNot(predicate: (Short) -> Boolean): List<Short> {
return filterNotTo(ArrayList<Short>(), predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a list containing all elements not matching the given [predicate]
*/
public inline fun <T> Iterable<T>.filterNot(predicate: (T) -> Boolean): List<T> {
return filterNotTo(ArrayList<T>(), predicate)
}
/**
* Returns a stream containing all elements not matching the given *predicate*
* Returns a stream containing all elements not matching the given [predicate]
*/
public fun <T> Stream<T>.filterNot(predicate: (T) -> Boolean): Stream<T> {
return FilteringStream(this, false, predicate)
}
/**
* Returns a list containing all elements not matching the given *predicate*
* Returns a string containing only those characters from the original string that do not match the given [predicate]
*/
public inline fun String.filterNot(predicate: (Char) -> Boolean): String {
return filterNotTo(StringBuilder(), predicate).toString()
@@ -543,7 +543,7 @@ public fun <T : Any> Stream<T?>.filterNotNull(): Stream<T> {
}
/**
* Appends all elements that are not null to the given *destination*
* Appends all elements that are not null to the given [destination]
*/
public fun <C : MutableCollection<in T>, T : Any> Array<out T?>.filterNotNullTo(destination: C): C {
for (element in this) if (element != null) destination.add(element)
@@ -551,7 +551,7 @@ public fun <C : MutableCollection<in T>, T : Any> Array<out T?>.filterNotNullTo(
}
/**
* Appends all elements that are not null to the given *destination*
* Appends all elements that are not null to the given [destination]
*/
public fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(destination: C): C {
for (element in this) if (element != null) destination.add(element)
@@ -559,7 +559,7 @@ public fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(d
}
/**
* Appends all elements that are not null to the given *destination*
* Appends all elements that are not null to the given [destination]
*/
public fun <C : MutableCollection<in T>, T : Any> Stream<T?>.filterNotNullTo(destination: C): C {
for (element in this) if (element != null) destination.add(element)
@@ -567,7 +567,7 @@ public fun <C : MutableCollection<in T>, T : Any> Stream<T?>.filterNotNullTo(des
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <T, C : MutableCollection<in T>> Array<out T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -575,7 +575,7 @@ public inline fun <T, C : MutableCollection<in T>> Array<out T>.filterNotTo(dest
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Boolean>> BooleanArray.filterNotTo(destination: C, predicate: (Boolean) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -583,7 +583,7 @@ public inline fun <C : MutableCollection<in Boolean>> BooleanArray.filterNotTo(d
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Byte>> ByteArray.filterNotTo(destination: C, predicate: (Byte) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -591,7 +591,7 @@ public inline fun <C : MutableCollection<in Byte>> ByteArray.filterNotTo(destina
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Char>> CharArray.filterNotTo(destination: C, predicate: (Char) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -599,7 +599,7 @@ public inline fun <C : MutableCollection<in Char>> CharArray.filterNotTo(destina
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Double>> DoubleArray.filterNotTo(destination: C, predicate: (Double) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -607,7 +607,7 @@ public inline fun <C : MutableCollection<in Double>> DoubleArray.filterNotTo(des
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Float>> FloatArray.filterNotTo(destination: C, predicate: (Float) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -615,7 +615,7 @@ public inline fun <C : MutableCollection<in Float>> FloatArray.filterNotTo(desti
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Int>> IntArray.filterNotTo(destination: C, predicate: (Int) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -623,7 +623,7 @@ public inline fun <C : MutableCollection<in Int>> IntArray.filterNotTo(destinati
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Long>> LongArray.filterNotTo(destination: C, predicate: (Long) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -631,7 +631,7 @@ public inline fun <C : MutableCollection<in Long>> LongArray.filterNotTo(destina
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <C : MutableCollection<in Short>> ShortArray.filterNotTo(destination: C, predicate: (Short) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -639,7 +639,7 @@ public inline fun <C : MutableCollection<in Short>> ShortArray.filterNotTo(desti
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -647,7 +647,7 @@ public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(desti
}
/**
* Appends all elements not matching the given *predicate* to the given *destination*
* Appends all elements not matching the given [predicate] to the given [destination]
*/
public inline fun <T, C : MutableCollection<in T>> Stream<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.add(element)
@@ -655,7 +655,7 @@ public inline fun <T, C : MutableCollection<in T>> Stream<T>.filterNotTo(destina
}
/**
* Appends all characters not matching the given *predicate* to the given *destination*
* Appends all characters not matching the given [predicate] to the given [destination]
*/
public inline fun <C : Appendable> String.filterNotTo(destination: C, predicate: (Char) -> Boolean): C {
for (element in this) if (!predicate(element)) destination.append(element)
@@ -663,7 +663,7 @@ public inline fun <C : Appendable> String.filterNotTo(destination: C, predicate:
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <T, C : MutableCollection<in T>> Array<out T>.filterTo(destination: C, predicate: (T) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -671,7 +671,7 @@ public inline fun <T, C : MutableCollection<in T>> Array<out T>.filterTo(destina
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Boolean>> BooleanArray.filterTo(destination: C, predicate: (Boolean) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -679,7 +679,7 @@ public inline fun <C : MutableCollection<in Boolean>> BooleanArray.filterTo(dest
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Byte>> ByteArray.filterTo(destination: C, predicate: (Byte) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -687,7 +687,7 @@ public inline fun <C : MutableCollection<in Byte>> ByteArray.filterTo(destinatio
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Char>> CharArray.filterTo(destination: C, predicate: (Char) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -695,7 +695,7 @@ public inline fun <C : MutableCollection<in Char>> CharArray.filterTo(destinatio
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Double>> DoubleArray.filterTo(destination: C, predicate: (Double) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -703,7 +703,7 @@ public inline fun <C : MutableCollection<in Double>> DoubleArray.filterTo(destin
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Float>> FloatArray.filterTo(destination: C, predicate: (Float) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -711,7 +711,7 @@ public inline fun <C : MutableCollection<in Float>> FloatArray.filterTo(destinat
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Int>> IntArray.filterTo(destination: C, predicate: (Int) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -719,7 +719,7 @@ public inline fun <C : MutableCollection<in Int>> IntArray.filterTo(destination:
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Long>> LongArray.filterTo(destination: C, predicate: (Long) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -727,7 +727,7 @@ public inline fun <C : MutableCollection<in Long>> LongArray.filterTo(destinatio
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <C : MutableCollection<in Short>> ShortArray.filterTo(destination: C, predicate: (Short) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -735,7 +735,7 @@ public inline fun <C : MutableCollection<in Short>> ShortArray.filterTo(destinat
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -743,7 +743,7 @@ public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destinat
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all elements matching the given [predicate] into the given [destination]
*/
public inline fun <T, C : MutableCollection<in T>> Stream<T>.filterTo(destination: C, predicate: (T) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
@@ -751,7 +751,7 @@ public inline fun <T, C : MutableCollection<in T>> Stream<T>.filterTo(destinatio
}
/**
* Appends all characters matching the given *predicate* to the given *destination*
* Appends all characters matching the given [predicate] to the given [destination]
*/
public inline fun <C : Appendable> String.filterTo(destination: C, predicate: (Char) -> Boolean): C {
for (index in 0..length - 1) {
@@ -872,7 +872,7 @@ public fun <T> List<T>.slice(indices: Iterable<Int>): List<T> {
}
/**
* Returns a list containing elements at specified positions
* Returns a string containing characters at specified positions
*/
public fun String.slice(indices: Iterable<Int>): String {
val result = StringBuilder()
@@ -883,7 +883,7 @@ public fun String.slice(indices: Iterable<Int>): String {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun <T> Array<out T>.take(n: Int): List<T> {
var count = 0
@@ -898,7 +898,7 @@ public fun <T> Array<out T>.take(n: Int): List<T> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun BooleanArray.take(n: Int): List<Boolean> {
var count = 0
@@ -913,7 +913,7 @@ public fun BooleanArray.take(n: Int): List<Boolean> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun ByteArray.take(n: Int): List<Byte> {
var count = 0
@@ -928,7 +928,7 @@ public fun ByteArray.take(n: Int): List<Byte> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun CharArray.take(n: Int): List<Char> {
var count = 0
@@ -943,7 +943,7 @@ public fun CharArray.take(n: Int): List<Char> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun DoubleArray.take(n: Int): List<Double> {
var count = 0
@@ -958,7 +958,7 @@ public fun DoubleArray.take(n: Int): List<Double> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun FloatArray.take(n: Int): List<Float> {
var count = 0
@@ -973,7 +973,7 @@ public fun FloatArray.take(n: Int): List<Float> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun IntArray.take(n: Int): List<Int> {
var count = 0
@@ -988,7 +988,7 @@ public fun IntArray.take(n: Int): List<Int> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun LongArray.take(n: Int): List<Long> {
var count = 0
@@ -1003,7 +1003,7 @@ public fun LongArray.take(n: Int): List<Long> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun ShortArray.take(n: Int): List<Short> {
var count = 0
@@ -1018,7 +1018,7 @@ public fun ShortArray.take(n: Int): List<Short> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun <T> Collection<T>.take(n: Int): List<T> {
var count = 0
@@ -1033,7 +1033,7 @@ public fun <T> Collection<T>.take(n: Int): List<T> {
}
/**
* Returns a list containing first *n* elements
* Returns a list containing first [n] elements
*/
public fun <T> Iterable<T>.take(n: Int): List<T> {
var count = 0
@@ -1054,14 +1054,14 @@ public fun <T> Stream<T>.take(n: Int): Stream<T> {
}
/**
* Returns a list containing first *n* elements
* Returns a string containing the first [n] characters from this string, or the entire string if this string is shorter
*/
public fun String.take(n: Int): String {
return substring(0, Math.min(n, length()))
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun <T> Array<out T>.takeWhile(predicate: (T) -> Boolean): List<T> {
val list = ArrayList<T>()
@@ -1074,7 +1074,7 @@ public inline fun <T> Array<out T>.takeWhile(predicate: (T) -> Boolean): List<T>
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun BooleanArray.takeWhile(predicate: (Boolean) -> Boolean): List<Boolean> {
val list = ArrayList<Boolean>()
@@ -1087,7 +1087,7 @@ public inline fun BooleanArray.takeWhile(predicate: (Boolean) -> Boolean): List<
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun ByteArray.takeWhile(predicate: (Byte) -> Boolean): List<Byte> {
val list = ArrayList<Byte>()
@@ -1100,7 +1100,7 @@ public inline fun ByteArray.takeWhile(predicate: (Byte) -> Boolean): List<Byte>
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun CharArray.takeWhile(predicate: (Char) -> Boolean): List<Char> {
val list = ArrayList<Char>()
@@ -1113,7 +1113,7 @@ public inline fun CharArray.takeWhile(predicate: (Char) -> Boolean): List<Char>
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun DoubleArray.takeWhile(predicate: (Double) -> Boolean): List<Double> {
val list = ArrayList<Double>()
@@ -1126,7 +1126,7 @@ public inline fun DoubleArray.takeWhile(predicate: (Double) -> Boolean): List<Do
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun FloatArray.takeWhile(predicate: (Float) -> Boolean): List<Float> {
val list = ArrayList<Float>()
@@ -1139,7 +1139,7 @@ public inline fun FloatArray.takeWhile(predicate: (Float) -> Boolean): List<Floa
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun IntArray.takeWhile(predicate: (Int) -> Boolean): List<Int> {
val list = ArrayList<Int>()
@@ -1152,7 +1152,7 @@ public inline fun IntArray.takeWhile(predicate: (Int) -> Boolean): List<Int> {
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun LongArray.takeWhile(predicate: (Long) -> Boolean): List<Long> {
val list = ArrayList<Long>()
@@ -1165,7 +1165,7 @@ public inline fun LongArray.takeWhile(predicate: (Long) -> Boolean): List<Long>
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun ShortArray.takeWhile(predicate: (Short) -> Boolean): List<Short> {
val list = ArrayList<Short>()
@@ -1178,7 +1178,7 @@ public inline fun ShortArray.takeWhile(predicate: (Short) -> Boolean): List<Shor
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a list containing first elements satisfying the given [predicate]
*/
public inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T> {
val list = ArrayList<T>()
@@ -1191,14 +1191,14 @@ public inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T>
}
/**
* Returns a stream containing first elements satisfying the given *predicate*
* Returns a stream containing first elements satisfying the given [predicate]
*/
public fun <T> Stream<T>.takeWhile(predicate: (T) -> Boolean): Stream<T> {
return TakeWhileStream(this, predicate)
}
/**
* Returns a list containing first elements satisfying the given *predicate*
* Returns a string containing the first characters that satisfy the given [predicate]
*/
public inline fun String.takeWhile(predicate: (Char) -> Boolean): String {
for (index in 0..length - 1)
libraries/stdlib/src/generated/_Strings.kt
+66 -66
View File
@@ -10,9 +10,9 @@ import java.util.*
import java.util.Collections // TODO: it's temporary while we have java.util.Collections in js
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <T, A : Appendable> Array<out T>.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -30,9 +30,9 @@ public fun <T, A : Appendable> Array<out T>.joinTo(buffer: A, separator: String
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> BooleanArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -50,9 +50,9 @@ public fun <A : Appendable> BooleanArray.joinTo(buffer: A, separator: String = "
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> ByteArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -70,9 +70,9 @@ public fun <A : Appendable> ByteArray.joinTo(buffer: A, separator: String = ", "
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> CharArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -90,9 +90,9 @@ public fun <A : Appendable> CharArray.joinTo(buffer: A, separator: String = ", "
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> DoubleArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -110,9 +110,9 @@ public fun <A : Appendable> DoubleArray.joinTo(buffer: A, separator: String = ",
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> FloatArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -130,9 +130,9 @@ public fun <A : Appendable> FloatArray.joinTo(buffer: A, separator: String = ",
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> IntArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -150,9 +150,9 @@ public fun <A : Appendable> IntArray.joinTo(buffer: A, separator: String = ", ",
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> LongArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -170,9 +170,9 @@ public fun <A : Appendable> LongArray.joinTo(buffer: A, separator: String = ", "
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <A : Appendable> ShortArray.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -190,9 +190,9 @@ public fun <A : Appendable> ShortArray.joinTo(buffer: A, separator: String = ",
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <T, A : Appendable> Iterable<T>.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -210,9 +210,9 @@ public fun <T, A : Appendable> Iterable<T>.joinTo(buffer: A, separator: String =
}
/**
* Appends the string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Appends the string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <T, A : Appendable> Stream<T>.joinTo(buffer: A, separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): A {
buffer.append(prefix)
@@ -230,99 +230,99 @@ public fun <T, A : Appendable> Stream<T>.joinTo(buffer: A, separator: String = "
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <T> Array<out T>.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun BooleanArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun ByteArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun CharArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun DoubleArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun FloatArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun IntArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun LongArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun ShortArray.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <T> Iterable<T>.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "..."
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun <T> Stream<T>.joinToString(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinTo(StringBuilder(), separator, prefix, postfix, limit, truncated).toString()
libraries/stdlib/src/kotlin/collections/AbstractIterator.kt
+7 -7
View File
@@ -13,8 +13,8 @@ private enum class State {
}
/**
* A base class to simplify implementing iterators so that implementations only have to implement [[computeNext()]]
* to implement the iterator, calling [[done()]] when the iteration is complete.
* A base class to simplify implementing iterators so that implementations only have to implement [computeNext]
* to implement the iterator, calling [done] when the iteration is complete.
*/
public abstract class AbstractIterator<T>: Iterator<T> {
private var state = State.NotReady
@@ -44,17 +44,17 @@ public abstract class AbstractIterator<T>: Iterator<T> {
/**
* Computes the next item in the iterator.
*
* This callback method should call one of these two methods
* This callback method should call one of these two methods:
*
* * [[setNext(T)]] with the next value of the iteration
* * [[done()]] to indicate there are no more elements
* * [setNext] with the next value of the iteration
* * [done] to indicate there are no more elements
*
* Failure to call either method will result in the iteration terminating with a failed state
*/
abstract protected fun computeNext(): Unit
/**
* Sets the next value in the iteration, called from the [[computeNext()]] function
* Sets the next value in the iteration, called from the [computeNext] function
*/
protected fun setNext(value: T): Unit {
nextValue = value
@@ -62,7 +62,7 @@ public abstract class AbstractIterator<T>: Iterator<T> {
}
/**
* Sets the state to done so that the iteration terminates
* Sets the state to done so that the iteration terminates.
*/
protected fun done() {
state = State.Done
libraries/stdlib/src/kotlin/collections/ArraysJVM.kt
+16 -1
View File
@@ -25,16 +25,31 @@ import kotlin.jvm.internal.Intrinsic
[Intrinsic("kotlin.arrays.array")] public fun booleanArray(vararg content : Boolean) : BooleanArray = content
/**
* Creates an input stream for reading data from this byte array.
*/
public val ByteArray.inputStream : ByteArrayInputStream
get() = ByteArrayInputStream(this)
/**
* Creates an input stream for reading data from the specified portion of this byte array.
* @param offset the start offset of the portion of the array to read.
* @param length the length of the portion of the array to read.
*/
public fun ByteArray.inputStream(offset: Int, length: Int) : ByteArrayInputStream = ByteArrayInputStream(this, offset, length)
/**
* Converts the contents of this byte array to a string using the specified [charset].
*/
public fun ByteArray.toString(charset: String): String = String(this, charset)
/**
* Converts the contents of this byte array to a string using the specified [charset].
*/
public fun ByteArray.toString(charset: Charset): String = String(this, charset)
[Intrinsic("kotlin.collections.copyToArray")] public fun <reified T> Collection<T>.copyToArray(): Array<T> =
throw UnsupportedOperationException()
/** Returns the List if its not null otherwise returns the empty list */
/** Returns the array if it's not null, or an empty array otherwise. */
public inline fun <reified T> Array<out T>?.orEmpty(): Array<out T> = this ?: array<T>()
libraries/stdlib/src/kotlin/collections/Iterators.kt
+3 -3
View File
@@ -3,7 +3,7 @@ package kotlin
import java.util.Enumeration
/**
* Helper to make java.util.Enumeration usable in for
* Creates an [Iterator] for an [Enumeration], allowing to use it in `for` loops.
*/
public fun <T> Enumeration<T>.iterator(): Iterator<T> = object : Iterator<T> {
override fun hasNext(): Boolean = hasMoreElements()
@@ -12,7 +12,7 @@ public fun <T> Enumeration<T>.iterator(): Iterator<T> = object : Iterator<T> {
}
/**
* Returns the given iterator itself. This allows to use an instance of iterator in a ranged for-loop
* Returns the given iterator itself. This allows to use an instance of iterator in a `for` loop.
*/
public fun <T> Iterator<T>.iterator(): Iterator<T> = this
@@ -26,7 +26,7 @@ public class IndexingIterable<out T>(private val iteratorFactory: () -> Iterator
}
/**
* Iterator transforming original *iterator* into iterator of [IndexedValue], counting index from zero.
* Iterator transforming original `iterator` into iterator of [IndexedValue], counting index from zero.
*/
public class IndexingIterator<out T>(private val iterator: Iterator<T>) : Iterator<IndexedValue<T>> {
private var index = 0
libraries/stdlib/src/kotlin/collections/JUtilJVM.kt
+2 -2
View File
@@ -3,12 +3,12 @@ package kotlin
import java.util.*
/**
* Returns a new [[SortedSet]] with the initial elements
* Returns a new [SortedSet] with the given elements.
*/
public fun sortedSetOf<T>(vararg values: T): TreeSet<T> = values.toCollection(TreeSet<T>())
/**
* Returns a new [[SortedSet]] with the given *comparator* and the initial elements
* Returns a new [SortedSet] with the given [comparator] and elements.
*/
public fun sortedSetOf<T>(comparator: Comparator<T>, vararg values: T): TreeSet<T> = values.toCollection(TreeSet<T>(comparator))
libraries/stdlib/src/kotlin/collections/Maps.kt
+77 -36
View File
@@ -21,17 +21,21 @@ private object EmptyMap : Map<Any, Any> {
/** Returns an empty read-only map of specified type */
public fun emptyMap<K, V>(): Map<K, V> = EmptyMap as Map<K, V>
/** Returns a new read-only map of given pairs, where the first value is the key, and the second is value */
/**
* Returns a new read-only map with the specified contents, given as a list of pairs
* where the first value is the key and the second is the value. If multiple pairs have
* the same key, the resulting map will contain the value from the last of those pairs.
*/
public fun mapOf<K, V>(vararg values: Pair<K, V>): Map<K, V> = if (values.size() == 0) emptyMap() else linkedMapOf(*values)
/** Returns an empty read-only map */
public fun mapOf<K, V>(): Map<K, V> = emptyMap()
/**
* Returns a new [[HashMap]] populated with the given pairs where the first value in each pair
* is the key and the second value is the value
* Returns a new [HashMap] with the specified contents, given as a list of pairs
* where the first component is the key and the second is the value.
*
* @includeFunctionBody ../../test/collections/MapTest.kt createUsingPairs
* @sample test.collections.MapTest.createUsingPairs
*/
public fun <K, V> hashMapOf(vararg values: Pair<K, V>): HashMap<K, V> {
val answer = HashMap<K, V>(values.size())
@@ -40,11 +44,11 @@ public fun <K, V> hashMapOf(vararg values: Pair<K, V>): HashMap<K, V> {
}
/**
* Returns a new [[LinkedHashMap]] populated with the given pairs where the first value in each pair
* is the key and the second value is the value. This map preserves insertion order so iterating through
* the map's entries will be in the same order
* Returns a new [LinkedHashMap] with the specified contents, given as a list of pairs
* where the first component is the key and the second is the value.
* This map preserves insertion order so iterating through the map's entries will be in the same order.
*
* @includeFunctionBody ../../test/collections/MapTest.kt createLinkedMap
* @sample test.collections.MapTest.createLinkedMap
*/
public fun <K, V> linkedMapOf(vararg values: Pair<K, V>): LinkedHashMap<K, V> {
val answer = LinkedHashMap<K, V>(values.size())
@@ -52,39 +56,67 @@ public fun <K, V> linkedMapOf(vararg values: Pair<K, V>): LinkedHashMap<K, V> {
return answer
}
/** Returns the [[Map]] if its not null otherwise it returns the empty [[Map]] */
/**
* Returns the [Map] if its not null, or the empty [Map] otherwise.
*/
public fun <K,V> Map<K,V>?.orEmpty() : Map<K,V>
= if (this != null) this else emptyMap()
/**
* Checks if the map contains the given key. This method allows to use the `x in map` syntax for checking
* whether an object is contained in the map.
*/
public fun <K,V> Map<K,V>.contains(key : K) : Boolean = containsKey(key)
/** Returns the key of the entry */
/**
* Allows to access the key of a map entry as a property. Equivalent to `getKey()`.
*/
public val <K, V> Map.Entry<K, V>.key: K
get() = getKey()
/** Returns the value of the entry */
/**
* Allows to access the value of a map entry as a property. Equivalent to `getValue()`.
*/
public val <K, V> Map.Entry<K, V>.value: V
get() = getValue()
/** Returns the key of the entry */
/**
* Returns the key component of the map entry. This method allows to use multi-declarations when working with maps,
* for example:
* ```
* for ((key, value) in map) {
* // do something with the key and the value
* }
* ```
*/
public fun <K, V> Map.Entry<K, V>.component1(): K {
return getKey()
}
/** Returns the value of the entry */
/**
* Returns the value component of the map entry. This method allows to use multi-declarations when working with maps,
* for example:
* ```
* for ((key, value) in map) {
* // do something with the key and the value
* }
* ```
*/
public fun <K, V> Map.Entry<K, V>.component2(): V {
return getValue()
}
/** Converts entry to Pair with key being first component and value being second */
/**
* Converts entry to [Pair] with key being first component and value being second.
*/
public fun <K, V> Map.Entry<K, V>.toPair(): Pair<K, V> {
return Pair(getKey(), getValue())
}
/**
* Returns the value for the given key or returns the result of the defaultValue function if there was no entry for the given key
* Returns the value for the given key, or the result of the [defaultValue] function if there was no entry for the given key.
*
* @includeFunctionBody ../../test/collections/MapTest.kt getOrElse
* @sample test.collections.MapTest.getOrElse
*/
public inline fun <K, V> Map<K, V>.getOrElse(key: K, defaultValue: () -> V): V {
if (containsKey(key)) {
@@ -95,9 +127,10 @@ public inline fun <K, V> Map<K, V>.getOrElse(key: K, defaultValue: () -> V): V {
}
/**
* Returns the value for the given key or the result of the defaultValue function is put into the map for the given value and returned
* Returns the value for the given key. If the key is not found in the map, calls the [defaultValue] function,
* puts its result into the map under the given key and returns it.
*
* @includeFunctionBody ../../test/collections/MapTest.kt getOrPut
* @sample test.collections.MapTest.getOrPut
*/
public inline fun <K, V> MutableMap<K, V>.getOrPut(key: K, defaultValue: () -> V): V {
if (containsKey(key)) {
@@ -110,9 +143,9 @@ public inline fun <K, V> MutableMap<K, V>.getOrPut(key: K, defaultValue: () -> V
}
/**
* Returns an [[Iterator]] over the entries in the [[Map]]
* Returns an [Iterator] over the entries in the [Map].
*
* @includeFunctionBody ../../test/collections/MapTest.kt iterateWithProperties
* @sample test.collections.MapTest.iterateWithProperties
*/
public fun <K, V> Map<K, V>.iterator(): Iterator<Map.Entry<K, V>> {
val entrySet = entrySet()
@@ -120,7 +153,8 @@ public fun <K, V> Map<K, V>.iterator(): Iterator<Map.Entry<K, V>> {
}
/**
* Populates the given *destination* [[Map]] with the value returned by applying the *transform* function on each [[Map.Entry]] in this [[Map]]
* Populates the given `destination` [Map] with entries having the keys of this map and the values obtained
* by applying the `transform` function to each entry in this [Map].
*/
public inline fun <K, V, R, C : MutableMap<K, R>> Map<K, V>.mapValuesTo(destination: C, transform: (Map.Entry<K, V>) -> R): C {
for (e in this) {
@@ -131,7 +165,8 @@ public inline fun <K, V, R, C : MutableMap<K, R>> Map<K, V>.mapValuesTo(destinat
}
/**
* Populates the given *destination* [[Map]] with the value returned by applying the *transform* function on each [[Map.Entry]] in this [[Map]]
* Populates the given `destination` [Map] with entries having the keys obtained
* by applying the `transform` function to each entry in this [Map] and the values of this map.
*/
public inline fun <K, V, R, C : MutableMap<R, V>> Map<K, V>.mapKeysTo(destination: C, transform: (Map.Entry<K, V>) -> R): C {
for (e in this) {
@@ -142,7 +177,7 @@ public inline fun <K, V, R, C : MutableMap<R, V>> Map<K, V>.mapKeysTo(destinatio
}
/**
* Puts all the entries into this [[MutableMap]] with the first value in the pair being the key and the second the value
* Puts all the given [values] into this [MutableMap] with the first component in the pair being the key and the second the value.
*/
public fun <K, V> MutableMap<K, V>.putAll(vararg values: Pair<K, V>): Unit {
for ((key, value) in values) {
@@ -151,7 +186,7 @@ public fun <K, V> MutableMap<K, V>.putAll(vararg values: Pair<K, V>): Unit {
}
/**
* Puts all the entries into this [[MutableMap]] with the first value in the pair being the key and the second the value
* Puts all the elements of the given collection into this [MutableMap] with the first component in the pair being the key and the second the value.
*/
public fun <K, V> MutableMap<K, V>.putAll(values: Iterable<Pair<K,V>>): Unit {
for ((key, value) in values) {
@@ -160,25 +195,27 @@ public fun <K, V> MutableMap<K, V>.putAll(values: Iterable<Pair<K,V>>): Unit {
}
/**
* Returns a new Map containing the results of applying the given *transform* function to each [[Map.Entry]] in this [[Map]]
* Returns a new map with entries having the keys of this map and the values obtained by applying the `transform`
* function to each entry in this [Map].
*
* @includeFunctionBody ../../test/collections/MapTest.kt mapValues
* @sample test.collections.MapTest.mapValues
*/
public inline fun <K, V, R> Map<K, V>.mapValues(transform: (Map.Entry<K, V>) -> R): Map<K, R> {
return mapValuesTo(LinkedHashMap<K, R>(size()), transform)
}
/**
* Returns a new Map containing the results of applying the given *transform* function to each [[Map.Entry]] in this [[Map]]
* Returns a new Map with entries having the keys obtained by applying the `transform` function to each entry in this
* [Map] and the values of this map.
*
* @includeFunctionBody ../../test/collections/MapTest.kt mapKeys
* @sample test.collections.MapTest.mapKeys
*/
public inline fun <K, V, R> Map<K, V>.mapKeys(transform: (Map.Entry<K, V>) -> R): Map<R, V> {
return mapKeysTo(LinkedHashMap<R, V>(size()), transform)
}
/**
* Returns a map containing all key-value pairs matching keys with the given *predicate*
* Returns a map containing all key-value pairs with keys matching the given [predicate].
*/
public inline fun <K, V> Map<K, V>.filterKeys(predicate: (K) -> Boolean): Map<K, V> {
val result = LinkedHashMap<K, V>()
@@ -191,7 +228,7 @@ public inline fun <K, V> Map<K, V>.filterKeys(predicate: (K) -> Boolean): Map<K,
}
/**
* Returns a map containing all key-value pairs matching values with the given *predicate*
* Returns a map containing all key-value pairs with values matching the given [predicate].
*/
public inline fun <K, V> Map<K, V>.filterValues(predicate: (V) -> Boolean): Map<K, V> {
val result = LinkedHashMap<K, V>()
@@ -205,7 +242,9 @@ public inline fun <K, V> Map<K, V>.filterValues(predicate: (V) -> Boolean): Map<
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all entries matching the given [predicate] into the mutable map given as [destination] parameter.
*
* @return the destination map.
*/
public inline fun <K, V, C : MutableMap<K, V>> Map<K, V>.filterTo(destination: C, predicate: (Map.Entry<K, V>) -> Boolean): C {
for (element in this) {
@@ -217,14 +256,16 @@ public inline fun <K, V, C : MutableMap<K, V>> Map<K, V>.filterTo(destination: C
}
/**
* Returns a map containing all key-value pairs matching the given *predicate*
* Returns a new map containing all key-value pairs matching the given [predicate].
*/
public inline fun <K, V> Map<K, V>.filter(predicate: (Map.Entry<K, V>) -> Boolean): Map<K, V> {
return filterTo(LinkedHashMap<K, V>(), predicate)
}
/**
* Appends all elements matching the given *predicate* into the given *destination*
* Appends all entries not matching the given [predicate] into the given [destination].
*
* @return the destination map.
*/
public inline fun <K, V, C : MutableMap<K, V>> Map<K, V>.filterNotTo(destination: C, predicate: (Map.Entry<K, V>) -> Boolean): C {
for (element in this) {
@@ -236,7 +277,7 @@ public inline fun <K, V, C : MutableMap<K, V>> Map<K, V>.filterNotTo(destination
}
/**
* Returns a map containing all key-value pairs matching the given *predicate*
* Returns a new map containing all key-value pairs not matching the given [predicate].
*/
public inline fun <K, V> Map<K, V>.filterNot(predicate: (Map.Entry<K, V>) -> Boolean): Map<K, V> {
return filterNotTo(LinkedHashMap<K, V>(), predicate)
@@ -250,7 +291,7 @@ public fun <K, V> MutableMap<K, V>.plusAssign(pair: Pair<K, V>) {
}
/**
* Returns a map containing all key-value pairs from the given collection
* Returns a new map containing all key-value pairs from the given collection of pairs.
*/
public fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V> {
val result = LinkedHashMap<K, V>()
@@ -261,6 +302,6 @@ public fun <K, V> Iterable<Pair<K, V>>.toMap(): Map<K, V> {
}
/**
* Converts this [Map] to a [LinkedHashMap] so future insertion orders are maintained
* Converts this [Map] to a [LinkedHashMap], maintaining the insertion order of elements added to that map afterwards.
*/
public fun <K, V> Map<K, V>.toLinkedMap(): MutableMap<K, V> = LinkedHashMap(this)
libraries/stdlib/src/kotlin/collections/MapsJVM.kt
+7 -7
View File
@@ -11,17 +11,17 @@ import java.util.Properties
public fun <K, V> MutableMap<K, V>.set(key: K, value: V): V? = put(key, value)
/**
* Converts this [[Map]] to a [[SortedMap]] so iteration order will be in key order
* Converts this [Map] to a [SortedMap] so iteration order will be in key order
*
* @includeFunctionBody ../../test/collections/MapTest.kt toSortedMap
*/
public fun <K : Any, V> Map<K, V>.toSortedMap(): SortedMap<K, V> = TreeMap(this)
/**
* Converts this [[Map]] to a [[SortedMap]] using the given *comparator* so that iteration order will be in the order
* Converts this [Map] to a [SortedMap] using the given [comparator] so that iteration order will be in the order
* defined by the comparator
*
* @includeFunctionBody ../../test/collections/MapTest.kt toSortedMapWithComparator
* @sample test.collections.MapJVMTest.toSortedMapWithComparator
*/
public fun <K, V> Map<K, V>.toSortedMap(comparator: Comparator<K>): SortedMap<K, V> {
val result = TreeMap<K, V>(comparator)
@@ -30,10 +30,10 @@ public fun <K, V> Map<K, V>.toSortedMap(comparator: Comparator<K>): SortedMap<K,
}
/**
* Returns a new [[SortedMap]] populated with the given pairs where the first value in each pair
* is the key and the second value is the value
* Returns a new [SortedMap] with the specified contents, given as a list of pairs
* where the first value is the key and the second is the value.
*
* @includeFunctionBody ../../test/collections/MapTest.kt createSortedMap
* @sample test.collections.MapJVMTest.createSortedMap
*/
public fun <K, V> sortedMapOf(vararg values: Pair<K, V>): SortedMap<K, V> {
val answer = TreeMap<K, V>()
@@ -49,7 +49,7 @@ public fun <K, V> sortedMapOf(vararg values: Pair<K, V>): SortedMap<K, V> {
/**
* Converts this [[Map]] to a [[Properties]] object
* Converts this [Map] to a [Properties] object
*
* @includeFunctionBody ../../test/collections/MapTest.kt toProperties
*/
libraries/stdlib/src/kotlin/collections/MutableCollections.kt
+8 -8
View File
@@ -1,7 +1,7 @@
package kotlin
/**
* Adds all elements of the given *iterable* to this [[MutableCollection]]
* Adds all elements of the given [iterable] to this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.addAll(iterable: Iterable<T>) {
when (iterable) {
@@ -11,21 +11,21 @@ public fun <T> MutableCollection<in T>.addAll(iterable: Iterable<T>) {
}
/**
* Adds all elements of the given *stream* to this [[MutableCollection]]
* Adds all elements of the given [stream] to this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.addAll(stream: Stream<T>) {
for (item in stream) add(item)
}
/**
* Adds all elements of the given *array* to this [[MutableCollection]]
* Adds all elements of the given [array] to this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.addAll(array: Array<out T>) {
for (item in array) add(item)
}
/**
* Removes all elements of the given *iterable* from this [[MutableCollection]]
* Removes all elements of the given [iterable] from this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.removeAll(iterable: Iterable<T>) {
when (iterable) {
@@ -35,21 +35,21 @@ public fun <T> MutableCollection<in T>.removeAll(iterable: Iterable<T>) {
}
/**
* Removes all elements of the given *stream* from this [[MutableCollection]]
* Removes all elements of the given [stream] from this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.removeAll(stream: Stream<T>) {
for (item in stream) remove(item)
}
/**
* Removes all elements of the given *array* from this [[MutableCollection]]
* Removes all elements of the given [array] from this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.removeAll(array: Array<out T>) {
for (item in array) remove(item)
}
/**
* Retains only elements of the given *iterable* in this [[MutableCollection]]
* Retains only elements of the given [iterable] in this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.retainAll(iterable: Iterable<T>) {
when (iterable) {
@@ -59,7 +59,7 @@ public fun <T> MutableCollection<in T>.retainAll(iterable: Iterable<T>) {
}
/**
* Retains only elements of the given *array* in this [[MutableCollection]]
* Retains only elements of the given [array] in this [MutableCollection].
*/
public fun <T> MutableCollection<in T>.retainAll(array: Array<out T>) {
retainAll(array.toSet())
libraries/stdlib/src/kotlin/collections/Operations.kt
+3 -3
View File
@@ -4,7 +4,7 @@ import java.util.ArrayList
import kotlin.platform.platformName
/**
* Returns a single list of all elements from all collections in original collection
* Returns a single list of all elements from all collections in the given collection.
*/
public fun <T> Iterable<Iterable<T>>.flatten(): List<T> {
val result = ArrayList<T>()
@@ -15,14 +15,14 @@ public fun <T> Iterable<Iterable<T>>.flatten(): List<T> {
}
/**
* Returns a stream of all elements from all streams in original stream
* Returns a stream of all elements from all streams in the given stream.
*/
public fun <T> Stream<Stream<T>>.flatten(): Stream<T> {
return FlatteningStream(this, { it })
}
/**
* Returns a single list of all elements from all collections in original collection
* Returns a single list of all elements from all arrays in the given array.
*/
public fun <T> Array<Array<out T>>.flatten(): List<T> {
val result = ArrayList<T>(sumBy { it.size() })
libraries/stdlib/src/kotlin/properties/Delegation.kt
+129
View File
@@ -1,20 +1,80 @@
package kotlin.properties
/**
* Base trait that can be used for implementing property delegates of read-only properties. This is provided only for
* convenience; you don't have to extend this trait as long as your property delegate has methods with the same
* signatures.
* @param R the type of object which owns the delegated property.
* @param T the type of the property value.
*/
public trait ReadOnlyProperty<in R, out T> {
/**
* Returns the value of the property for the given object.
* @param thisRef the object for which the value is requested.
* @param desc the metadata for the property.
* @return the property value.
*/
public fun get(thisRef: R, desc: PropertyMetadata): T
}
/**
* Base trait that can be used for implementing property delegates of read-only properties. This is provided only for
* convenience; you don't have to extend this trait as long as your property delegate has methods with the same
* signatures.
* @param R the type of object which owns the delegated property.
* @param T the type of the property value.
*/
public trait ReadWriteProperty<in R, T> {
/**
* Returns the value of the property for the given object.
* @param thisRef the object for which the value is requested.
* @param desc the metadata for the property.
* @return the property value.
*/
public fun get(thisRef: R, desc: PropertyMetadata): T
/**
* Sets the value of the property for the given object.
* @param thisRef the object for which the value is requested.
* @param desc the metadata for the property.
* @param value the value to set.
*/
public fun set(thisRef: R, desc: PropertyMetadata, value: T)
}
/**
* Standard property delegates.
*/
public object Delegates {
/**
* Returns a property delegate for a read/write property with a non-null value that is initialized not during
* object construction time but at a later time. Trying to read the property before the initial value has been
* assigned results in an exception.
*/
public fun notNull<T: Any>(): ReadWriteProperty<Any?, T> = NotNullVar()
/**
* Returns a property delegate for a read-only property that is initialized on first access by calling the
* specified block of code. Supports lazy initialization semantics for properties.
* @param initializer the function that returns the value of the property.
*/
public fun lazy<T>(initializer: () -> T): ReadOnlyProperty<Any?, T> = LazyVal(initializer)
/**
* Returns a property delegate for a read-only property that is initialized on first access by calling the
* specified block of code under a specified lock. Supports lazy initialization semantics for properties and
* concurrent access.
* @param lock the object the monitor of which is locked before calling the initializer block. If not specified,
* the property delegate object itself is used as a lock.
* @param initializer the function that returns the value of the property.
*/
public fun blockingLazy<T>(lock: Any? = null, initializer: () -> T): ReadOnlyProperty<Any?, T> = BlockingLazyVal(lock, initializer)
/**
* Returns a property delegate for a read/write property that calls a specified callback function when changed.
* @param initial the initial value of the property.
* @param onChange the callback which is called when the property value is changed.
*/
public fun observable<T>(initial: T, onChange: (desc: PropertyMetadata, oldValue: T, newValue: T) -> Unit): ReadWriteProperty<Any?, T> {
return ObservableProperty<T>(initial) { (desc, old, new) ->
onChange(desc, old, new)
@@ -22,15 +82,34 @@ public object Delegates {
}
}
/**
* Returns a property delegate for a read/write property that calls a specified callback function when changed,
* allowing the callback to veto the modification.
* @param initial the initial value of the property.
* @param onChange the callback which is called when a change to the property value is attempted. The new value
* is saved if the callback returns true and discarded if the callback returns false.
*/
public fun vetoable<T>(initial: T, onChange: (desc: PropertyMetadata, oldValue: T, newValue: T) -> Boolean): ReadWriteProperty<Any?, T> {
return ObservableProperty<T>(initial, onChange)
}
/**
* Returns a property delegate for a read/write property that stores its value in a map, using the property name
* as a key.
* @param map the map where the property values are stored.
* @param default the function returning the value of the property for a given object if it's missing from the given map.
*/
public fun mapVar<T>(map: MutableMap<in String, Any?>,
default: (thisRef: Any?, desc: String) -> T = defaultValueProvider): ReadWriteProperty<Any?, T> {
return FixedMapVar<Any?, String, T>(map, defaultKeyProvider, default)
}
/**
* Returns a property delegate for a read-only property that takes its value from a map, using the property name
* as a key.
* @param map the map where the property values are stored.
* @param default the function returning the value of the property for a given object if it's missing from the given map.
*/
public fun mapVal<T>(map: Map<in String, Any?>,
default: (thisRef: Any?, desc: String) -> T = defaultValueProvider): ReadOnlyProperty<Any?, T> {
return FixedMapVal<Any?, String, T>(map, defaultKeyProvider, default)
@@ -50,6 +129,12 @@ private class NotNullVar<T: Any>() : ReadWriteProperty<Any?, T> {
}
}
/**
* Implements a property delegate for a read/write property that calls a specified callback function when changed.
* @param initialValue the initial value of the property.
* @param onChange the callback which is called when a change to the property value is attempted. The new value
* is saved if the callback returns true and discarded if the callback returns false.
*/
public class ObservableProperty<T>(
initialValue: T, private val onChange: (name: PropertyMetadata, oldValue: T, newValue: T) -> Boolean
) : ReadWriteProperty<Any?, T> {
@@ -111,12 +196,36 @@ private class BlockingLazyVal<T>(lock: Any?, private val initializer: () -> T) :
}
}
/**
* Exception thrown by the default implementation of property delegates which store values in a map
* when the map does not contain the corresponding key.
*/
public class KeyMissingException(message: String): RuntimeException(message)
/**
* Implements the core logic for a property delegate that stores property values in a map.
* @param T the type of the object that owns the delegated property.
* @param K the type of key in the map.
* @param V the type of the property value.
*/
public abstract class MapVal<T, K, out V>() : ReadOnlyProperty<T, V> {
/**
* Returns the map used to store the values of the properties of the given object instance.
* @param ref the object instance for which the map is requested.
*/
protected abstract fun map(ref: T): Map<in K, Any?>
/**
* Returns the map key used to store the values of the given property.
* @param desc the property for which the key is requested.
*/
protected abstract fun key(desc: PropertyMetadata): K
/**
* Returns the property value to be used when the map does not contain the corresponding key.
* @param ref the object instance for which the value was requested.
* @param desc the property for which the value was requested.
*/
protected open fun default(ref: T, desc: PropertyMetadata): V {
throw KeyMissingException("Key $desc is missing in $ref")
}
@@ -132,6 +241,12 @@ public abstract class MapVal<T, K, out V>() : ReadOnlyProperty<T, V> {
}
}
/**
* Implements the core logic for a read/write property delegate that stores property values in a map.
* @param T the type of the object that owns the delegated property.
* @param K the type of key in the map.
* @param V the type of the property value.
*/
public abstract class MapVar<T, K, V>() : MapVal<T, K, V>(), ReadWriteProperty<T, V> {
protected abstract override fun map(ref: T): MutableMap<in K, Any?>
@@ -144,6 +259,13 @@ public abstract class MapVar<T, K, V>() : MapVal<T, K, V>(), ReadWriteProperty<T
private val defaultKeyProvider:(PropertyMetadata) -> String = {it.name}
private val defaultValueProvider:(Any?, Any?) -> Nothing = {(thisRef, key) -> throw KeyMissingException("$key is missing from $thisRef")}
/**
* Implements a read-only property delegate that stores the property values in a given map instance and uses the given
* callback functions for calculating the key and the default value for each property.
* @param map the map used to store the values.
* @param key the function to calculate the map key from a property metadata object.
* @param default the function returning the value of the property for a given object if it's missing from the given map.
*/
public open class FixedMapVal<T, K, out V>(private val map: Map<in K, Any?>,
private val key: (PropertyMetadata) -> K,
private val default: (ref: T, key: K) -> V = defaultValueProvider) : MapVal<T, K, V>() {
@@ -160,6 +282,13 @@ public open class FixedMapVal<T, K, out V>(private val map: Map<in K, Any?>,
}
}
/**
* Implements a read/write property delegate that stores the property values in a given map instance and uses the given
* callback functions for calculating the key and the default value for each property.
* @param map the map used to store the values.
* @param key the function to calculate the map key from a property metadata object.
* @param default the function returning the value of the property for a given object if it's missing from the given map.
*/
public open class FixedMapVar<T, K, V>(private val map: MutableMap<in K, Any?>,
private val key: (PropertyMetadata) -> K,
private val default: (ref: T, key: K) -> V = defaultValueProvider) : MapVar<T, K, V>() {
libraries/stdlib/src/kotlin/text/Strings.kt
+106 -82
View File
@@ -6,7 +6,10 @@ public fun String.trim(text: String): String = trimLeading(text).trimTrailing(te
/** Returns the string with the prefix and postfix text trimmed */
public fun String.trim(prefix: String, postfix: String): String = trimLeading(prefix).trimTrailing(postfix)
/** Returns the string with the leading prefix of this string removed */
/**
* If this string starts with the given [prefix], returns a copy of this string
* with the prefix removed. Otherwise, returns this string.
*/
public fun String.trimLeading(prefix: String): String {
var answer = this
if (answer.startsWith(prefix)) {
@@ -15,7 +18,10 @@ public fun String.trimLeading(prefix: String): String {
return answer
}
/** Returns the string with the trailing postfix of this string removed */
/**
* If this string ends with the given [postfix], returns a copy of this string
* with the postfix removed. Otherwise, returns this string.
*/
public fun String.trimTrailing(postfix: String): String {
var answer = this
if (answer.endsWith(postfix)) {
@@ -24,7 +30,9 @@ public fun String.trimTrailing(postfix: String): String {
return answer
}
/** Returns a new String containing the everything but the leading whitespace characters */
/**
* Returns a copy of this String with leading whitespace removed.
*/
public fun String.trimLeading(): String {
var count = 0
@@ -34,7 +42,9 @@ public fun String.trimLeading(): String {
return if (count > 0) substring(count) else this
}
/** Returns a new String containing the everything but the trailing whitespace characters */
/**
* Returns a copy of this String with trailing whitespace removed.
*/
public fun String.trimTrailing(): String {
var count = this.length
@@ -58,12 +68,22 @@ public fun CharSequence.iterator(): CharIterator = object : CharIterator() {
public override fun hasNext(): Boolean = index < length
}
/** Returns the string if it is not null or the empty string if its null */
/** Returns the string if it is not null, or the empty string otherwise. */
public fun String?.orEmpty(): String = this ?: ""
/**
* Returns the range of valid character indices for this string.
*/
public val String.indices: IntRange
get() = 0..length() - 1
/**
* Returns a character at the given index in a [CharSequence]. Allows to use the
* index operator for working with character sequences:
* ```
* val c = charSequence[5]
* ```
*/
public fun CharSequence.get(index: Int): Char = this.charAt(index)
/**
@@ -73,7 +93,7 @@ public val String.lastIndex: Int
get() = this.length() - 1
/**
* Returns a subsequence specified by given set of indices.
* Returns a subsequence obtained by taking the characters at the given [indices] in this sequence.
*/
public fun CharSequence.slice(indices: Iterable<Int>): CharSequence {
val sb = StringBuilder()
@@ -84,109 +104,113 @@ public fun CharSequence.slice(indices: Iterable<Int>): CharSequence {
}
/**
* Returns a substring specified by given range
* Returns a substring specified by the given [range].
*/
public fun String.substring(range: IntRange): String = substring(range.start, range.end + 1)
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a collection could be huge you can specify a non-negative value of *limit* which will only show a subset of the collection then it will
* a special *truncated* separator (which defaults to "...")
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the collection could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun Iterable<String>.join(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinToString(separator, prefix, postfix, limit, truncated)
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If an array could be huge you can specify a non-negative value of *limit* which will only show a subset of the array then it will
* a special *truncated* separator (which defaults to "...")
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the array could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun Array<String>.join(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinToString(separator, prefix, postfix, limit, truncated)
}
/**
* Creates a string from all the elements separated using the *separator* and using the given *prefix* and *postfix* if supplied.
* If a stream could be huge you can specify a non-negative value of *limit* which will only show a subset of the stream then it will
* a special *truncated* separator (which defaults to "...")
* Creates a string from all the elements separated using [separator] and using the given [prefix] and [postfix] if supplied.
* If the stream could be huge, you can specify a non-negative value of [limit], in which case only the first [limit]
* elements will be appended, followed by the [truncated] string (which defaults to "...").
*/
public fun Stream<String>.join(separator: String = ", ", prefix: String = "", postfix: String = "", limit: Int = -1, truncated: String = "..."): String {
return joinToString(separator, prefix, postfix, limit, truncated)
}
/**
* Returns a substring before first occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring before the first occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringBefore(delimiter: Char, missingSeparatorValue : String = this): String {
public fun String.substringBefore(delimiter: Char, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(0, index)
return if (index == -1) missingDelimiterValue else substring(0, index)
}
/**
* Returns a substring before first occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring before the first occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringBefore(delimiter: String, missingSeparatorValue : String = this): String {
public fun String.substringBefore(delimiter: String, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(0, index)
return if (index == -1) missingDelimiterValue else substring(0, index)
}
/**
* Returns a substring after first occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring after the first occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringAfter(delimiter: Char, missingSeparatorValue : String = this): String {
public fun String.substringAfter(delimiter: Char, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(index + 1, length)
return if (index == -1) missingDelimiterValue else substring(index + 1, length)
}
/**
* Returns a substring after first occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring after the first occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringAfter(delimiter: String, missingSeparatorValue : String = this): String {
public fun String.substringAfter(delimiter: String, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(index + delimiter.length, length)
return if (index == -1) missingDelimiterValue else substring(index + delimiter.length, length)
}
/**
* Returns a substring before last occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring before the last occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringBeforeLast(delimiter: Char, missingSeparatorValue : String = this): String {
public fun String.substringBeforeLast(delimiter: Char, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(0, index)
return if (index == -1) missingDelimiterValue else substring(0, index)
}
/**
* Returns a substring before last occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring before the last occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringBeforeLast(delimiter: String, missingSeparatorValue : String = this): String {
public fun String.substringBeforeLast(delimiter: String, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(0, index)
return if (index == -1) missingDelimiterValue else substring(0, index)
}
/**
* Returns a substring after last occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring after the last occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringAfterLast(delimiter: Char, missingSeparatorValue : String = this): String {
public fun String.substringAfterLast(delimiter: Char, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(index + 1, length)
return if (index == -1) missingDelimiterValue else substring(index + 1, length)
}
/**
* Returns a substring after last occurrence of delimiter.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Returns a substring after the last occurrence of [delimiter].
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.substringAfterLast(delimiter: String, missingSeparatorValue : String = this): String {
public fun String.substringAfterLast(delimiter: String, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else substring(index + delimiter.length, length)
return if (index == -1) missingDelimiterValue else substring(index + delimiter.length, length)
}
/**
* Replace part of string at given range with replacement string
* Replaces the part of the string at the given range with the [replacement] string.
* @param firstIndex the index of the first character to be replaced.
* @param lastIndex the index of the first character after the replacement to keep in the string.
*/
public fun String.replaceRange(firstIndex: Int, lastIndex: Int, replacement: String): String {
if (lastIndex < firstIndex)
@@ -199,7 +223,7 @@ public fun String.replaceRange(firstIndex: Int, lastIndex: Int, replacement: Str
}
/**
* Replace part of string at given range with replacement string
* Replace the part of string at the given [range] with the [replacement] string.
*/
public fun String.replaceRange(range: IntRange, replacement: String): String {
if (range.end < range.start)
@@ -212,73 +236,73 @@ public fun String.replaceRange(range: IntRange, replacement: String): String {
}
/**
* Replace part of string before first occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string before the first occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceBefore(delimiter: Char, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceBefore(delimiter: Char, replacement: String, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(0, index, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(0, index, replacement)
}
/**
* Replace part of string before first occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string before the first occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceBefore(delimiter: String, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceBefore(delimiter: String, replacement: String, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(0, index, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(0, index, replacement)
}
/**
* Replace part of string after first occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string after the first occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceAfter(delimiter: Char, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceAfter(delimiter: Char, replacement: String, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(index + 1, length, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(index + 1, length, replacement)
}
/**
* Replace part of string after first occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string after the first occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceAfter(delimiter: String, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceAfter(delimiter: String, replacement: String, missingDelimiterValue: String = this): String {
val index = indexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(index + delimiter.length, length, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(index + delimiter.length, length, replacement)
}
/**
* Replace part of string after last occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string after the last occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceAfterLast(delimiter: String, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceAfterLast(delimiter: String, replacement: String, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(index + delimiter.length, length, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(index + delimiter.length, length, replacement)
}
/**
* Replace part of string after last occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string after the last occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceAfterLast(delimiter: Char, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceAfterLast(delimiter: Char, replacement: String, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(index + 1, length, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(index + 1, length, replacement)
}
/**
* Replace part of string before last occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string before the last occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceBeforeLast(delimiter: Char, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceBeforeLast(delimiter: Char, replacement: String, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(0, index, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(0, index, replacement)
}
/**
* Replace part of string before last occurrence of given delimiter with replacement string.
* In case of no delimiter, returns the value of missingSeparatorValue which defaults to original string.
* Replace part of string before the last occurrence of given delimiter with the [replacement] string.
* If the string does not contain the delimiter, returns [missingDelimiterValue] which defaults to the original string.
*/
public fun String.replaceBeforeLast(delimiter: String, replacement: String, missingSeparatorValue : String = this): String {
public fun String.replaceBeforeLast(delimiter: String, replacement: String, missingDelimiterValue: String = this): String {
val index = lastIndexOf(delimiter)
return if (index == -1) missingSeparatorValue else replaceRange(0, index, replacement)
return if (index == -1) missingDelimiterValue else replaceRange(0, index, replacement)
}
libraries/stdlib/src/kotlin/util/AssertionsJVM.kt
+2 -2
View File
@@ -7,7 +7,7 @@ deprecated("Must be public to make assert() inlinable")
public val ASSERTIONS_ENABLED: Boolean = _Assertions.javaClass.desiredAssertionStatus()
/**
* Throws an [AssertionError] with an optional *message* if the *value* is false
* Throws an [AssertionError] with an optional [message] if the [value] is false
* and runtime assertions have been enabled on the JVM using the *-ea* JVM option.
*/
public fun assert(value: Boolean, message: Any = "Assertion failed") {
@@ -19,7 +19,7 @@ public fun assert(value: Boolean, message: Any = "Assertion failed") {
}
/**
* Throws an [AssertionError] calculated by *lazyMessage* if the *value* is false
* Throws an [AssertionError] calculated by [lazyMessage] if the [value] is false
* and runtime assertions have been enabled on the JVM using the *-ea* JVM option.
*/
public inline fun assert(value: Boolean, lazyMessage: () -> Any) {
libraries/stdlib/src/kotlin/util/Integers.kt
+3
View File
@@ -1,5 +1,8 @@
package kotlin
/**
* Executes the given function [body] the number of times equal to the value of this integer.
*/
public inline fun Int.times(body : () -> Unit) {
var count = this;
while (count > 0) {
libraries/stdlib/src/kotlin/util/JLangJVM.kt
+16 -3
View File
@@ -10,21 +10,34 @@ import kotlin.jvm.internal.Intrinsic
*
* Example:
*
* throws(javaClass<IOException>())
* fun readFile(name: String): String {...}
* ```
* throws(javaClass<IOException>())
* fun readFile(name: String): String {...}
* ```
*
* will be translated to
*
* String readFile(String name) throws IOException {...}
* ```
* String readFile(String name) throws IOException {...}
* ```
*/
Retention(RetentionPolicy.SOURCE)
public annotation class throws(public vararg val exceptionClasses: Class<out Throwable>)
/**
* Returns the runtime Java class of this object.
*/
[Intrinsic("kotlin.javaClass.property")] public val <T: Any> T.javaClass : Class<T>
get() = (this as java.lang.Object).getClass() as Class<T>
/**
* Returns the Java class for the specified type.
*/
[Intrinsic("kotlin.javaClass.function")] public fun <reified T: Any> javaClass(): Class<T> = null as Class<T>
/**
* Executes the given function [block] while holding the monitor of the given object [lock].
*/
public inline fun <R> synchronized(lock: Any, block: () -> R): R {
monitorEnter(lock)
try {
libraries/stdlib/src/kotlin/util/Numbers.kt
+4 -4
View File
@@ -1,13 +1,13 @@
package kotlin
/**
* Returns {@code true} if the specified number is a
* Not-a-Number (NaN) value, {@code false} otherwise.
* Returns `true` if the specified number is a
* Not-a-Number (NaN) value, `false` otherwise.
*/
public fun Double.isNaN(): Boolean = this != this
/**
* Returns {@code true} if the specified number is a
* Not-a-Number (NaN) value, {@code false} otherwise.
* Returns `true` if the specified number is a
* Not-a-Number (NaN) value, `false` otherwise.
*/
public fun Float.isNaN(): Boolean = this != this
libraries/stdlib/src/kotlin/util/Ordering.kt
+8 -2
View File
@@ -19,7 +19,10 @@ package kotlin
import java.util.Comparator
/**
* Compares two values using the sequence of functions to calculate a result of comparison.
* Compares two values using the specified sequence of functions to calculate the result of the comparison.
* The functions are called sequentially, receive the given values [a] and [b] and return [Comparable]
* objects. As soon as the [Comparable] instances returned by a function for [a] and [b] values do not
* compare as equal, the result of that comparison is returned.
*/
public fun <T : Any> compareValuesBy(a: T?, b: T?, vararg functions: (T) -> Comparable<*>?): Int {
require(functions.size() > 0)
@@ -36,7 +39,7 @@ public fun <T : Any> compareValuesBy(a: T?, b: T?, vararg functions: (T) -> Comp
}
/**
* Compares two [Comparable] nullable values, null is considered less than any value.
* Compares two nullable [Comparable] values. Null is considered less than any value.
*/
public fun <T : Comparable<*>> compareValues(a: T?, b: T?): Int {
if (a identityEquals b) return 0
@@ -48,6 +51,9 @@ public fun <T : Comparable<*>> compareValues(a: T?, b: T?): Int {
/**
* Creates a comparator using the sequence of functions to calculate a result of comparison.
* The functions are called sequentially, receive the given values [a] and [b] and return [Comparable]
* objects. As soon as the [Comparable] instances returned by a function for [a] and [b] values do not
* compare as equal, the result of that comparison is returned from the [Comparator].
*/
public fun <T> compareBy(vararg functions: (T) -> Comparable<*>?): Comparator<T> {
return object : Comparator<T> {
libraries/stdlib/src/kotlin/util/Preconditions.kt
+16 -16
View File
@@ -5,9 +5,9 @@ import java.lang.IllegalArgumentException
import java.lang.IllegalStateException
/**
* Throws an [IllegalArgumentException] with an optional *message* if the *value* is false.
* Throws an [IllegalArgumentException] with an optional [message] if the [value] is false.
*
* ${code test.collections.PreconditionsTest.failingRequireWithMessage}
* @sample test.collections.PreconditionsTest.failingRequireWithMessage
*/
public fun require(value: Boolean, message: Any = "Failed requirement"): Unit {
if (!value) {
@@ -16,9 +16,9 @@ public fun require(value: Boolean, message: Any = "Failed requirement"): Unit {
}
/**
* Throws an [IllegalArgumentException] with the *lazyMessage* if the *value* is false.
* Throws an [IllegalArgumentException] with the result of calling [lazyMessage] if the [value] is false.
*
* ${code test.collections.PreconditionsTest.failingRequireWithLazyMessage}
* @sample test.collections.PreconditionsTest.failingRequireWithLazyMessage
*/
public inline fun require(value: Boolean, lazyMessage: () -> Any): Unit {
if (!value) {
@@ -28,10 +28,10 @@ public inline fun require(value: Boolean, lazyMessage: () -> Any): Unit {
}
/**
* Throws an [IllegalArgumentException] with the given *message* if the *value* is null otherwise
* the not null value is returned.
* Throws an [IllegalArgumentException] with the given [message] if the [value] is null. Otherwise
* returns the not null value.
*
* ${code test.collections.PreconditionsTest.requireNotNull}
* @sample test.collections.PreconditionsTest.requireNotNull
*/
public fun <T:Any> requireNotNull(value: T?, message: Any = "Required value was null"): T {
if (value == null) {
@@ -42,9 +42,9 @@ public fun <T:Any> requireNotNull(value: T?, message: Any = "Required value was
}
/**
* Throws an [IllegalStateException] with an optional *message* if the *value* is false.
* Throws an [IllegalStateException] with an optional [message] if the [value] is false.
*
* ${code test.collections.PreconditionsTest.failingCheckWithMessage}
* @sample test.collections.PreconditionsTest.failingCheckWithMessage
*/
public fun check(value: Boolean, message: Any = "Check failed"): Unit {
if (!value) {
@@ -53,9 +53,9 @@ public fun check(value: Boolean, message: Any = "Check failed"): Unit {
}
/**
* Throws an [IllegalStateException] with the *lazyMessage* if the *value* is false.
* Throws an [IllegalStateException] with the result of calling [lazyMessage] if the [value] is false.
*
* ${code test.collections.PreconditionsTest.failingCheckWithLazyMessage}
* @sample test.collections.PreconditionsTest.failingCheckWithLazyMessage
*/
public inline fun check(value: Boolean, lazyMessage: () -> Any): Unit {
if (!value) {
@@ -65,10 +65,10 @@ public inline fun check(value: Boolean, lazyMessage: () -> Any): Unit {
}
/**
* Throws an [IllegalStateException] with the given *message* if the *value* is null otherwise
* the not null value is returned.
* Throws an [IllegalArgumentException] with the given [message] if the [value] is null. Otherwise
* returns the not null value.
*
* ${code test.collections.PreconditionsTest.checkNotNull}
* @sample test.collections.PreconditionsTest.checkNotNull
*/
public fun <T:Any> checkNotNull(value: T?, message: Any = "Required value was null"): T {
if (value == null) {
@@ -79,8 +79,8 @@ public fun <T:Any> checkNotNull(value: T?, message: Any = "Required value was nu
}
/**
* Throws an [IllegalStateException] with the given *message*
* Throws an [IllegalStateException] with the given [message]
*
* ${code test.collections.PreconditionsTest.error}
* @sample test.collections.PreconditionsTest.error
*/
public fun error(message: Any): Nothing = throw IllegalStateException(message.toString())
libraries/stdlib/src/kotlin/util/Standard.kt
+5 -5
View File
@@ -1,15 +1,15 @@
package kotlin
/**
* Creates a tuple of type [[Pair<A,B>]] from this and *that* which can be useful for creating [[Map]] literals
* with less noise, for example
* @includeFunctionBody ../../test/collections/MapTest.kt createUsingTo
* Creates a tuple of type [Pair] from this and [that].
*
* This can be useful for creating [Map] literals with less noise, for example:
* @sample test.collections.MapTest.createUsingTo
*/
public fun <A, B> A.to(that: B): Pair<A, B> = Pair(this, that)
/**
Run function f
* Calls the specified function.
*/
public inline fun <T> run(f: () -> T): T = f()
libraries/stdlib/src/kotlin/util/StandardJVM.kt
+3 -4
View File
@@ -4,7 +4,7 @@ import java.io.PrintWriter
import java.io.PrintStream
/**
* Allows a stack trace to be printed from Kotlin's [[Throwable]]
* Allows a stack trace to be printed from Kotlin's [Throwable].
*/
public fun Throwable.printStackTrace(writer: PrintWriter): Unit {
val jlt = this as java.lang.Throwable
@@ -12,7 +12,7 @@ public fun Throwable.printStackTrace(writer: PrintWriter): Unit {
}
/**
* Allows a stack trace to be printed from Kotlin's [[Throwable]]
* Allows a stack trace to be printed from Kotlin's [Throwable]
*/
public fun Throwable.printStackTrace(stream: PrintStream): Unit {
val jlt = this as java.lang.Throwable
@@ -20,9 +20,8 @@ public fun Throwable.printStackTrace(stream: PrintStream): Unit {
}
/**
* Returns the stack trace
* Returns the list of stack trace elements in a Kotlin stack trace.
*/
public fun Throwable.getStackTrace(): Array<StackTraceElement> {
val jlt = this as java.lang.Throwable
return jlt.getStackTrace()!!
libraries/stdlib/src/kotlin/util/SystemJVM.kt
+4 -4
View File
@@ -1,8 +1,8 @@
package kotlin.util
/**
Executes current block and returns elapsed time in milliseconds
*/
* Executes the given block and returns elapsed time in milliseconds.
*/
public fun measureTimeMillis(block: () -> Unit) : Long {
val start = System.currentTimeMillis()
block()
@@ -10,8 +10,8 @@ public fun measureTimeMillis(block: () -> Unit) : Long {
}
/**
Executes current block and returns elapsed time in nanoseconds
*/
* Executes the given block and returns elapsed time in nanoseconds.
*/
public fun measureTimeNano(block: () -> Unit) : Long {
val start = System.nanoTime()
block()
libraries/stdlib/src/kotlin/util/Tuples.kt
+15 -10
View File
@@ -9,11 +9,13 @@ import java.io.Serializable
* Pair exhibits value semantics, i.e. two pairs are equal if both components are equal.
*
* An example of decomposing it into values:
* ${code test.tuples.PairTest.pairMultiAssignment}
* @sample test.tuples.PairTest.pairMultiAssignment
*
* $constructor: Creates new instance of [Pair]
* $first: First value
* $second: Second value
* @param A type of the first value
* @param B type of the second value
* @param first First value
* @param second Second value
* @constructor Creates a new instance of Pair.
*/
public data class Pair<out A, out B>(
public val first: A,
@@ -27,7 +29,7 @@ public data class Pair<out A, out B>(
}
/**
* Converts pair into a list
* Converts a pair into a list.
*/
public fun <T> Pair<T, T>.toList(): List<T> = listOf(first, second)
@@ -37,11 +39,14 @@ public fun <T> Pair<T, T>.toList(): List<T> = listOf(first, second)
* There is no meaning attached to values in this class, it can be used for any purpose.
* Triple exhibits value semantics, i.e. two triples are equal if all three components are equal.
* An example of decomposing it into values:
* {code test.tuples.PairTest.pairMultiAssignment}
* @sample test.tuples.TripleTest.tripleMultiAssignment
*
* $first: First value
* $second: Second value
* $third: Third value
* @param A type of the first value
* @param B type of the second value
* @param C type of the third value
* @param first First value
* @param second Second value
* @param third Third value
*/
public data class Triple<out A, out B, out C>(
public val first: A,
@@ -50,7 +55,7 @@ public data class Triple<out A, out B, out C>(
) : Serializable {
/**
* Returns string representation of the [Triple] including its [first] and [second] values.
* Returns string representation of the [Triple] including its [first], [second] and [third] values.
*/
public override fun toString(): String = "($first, $second, $third)"
}