Add samples for take* and drop* extensions (KT-20357)

- Add samples for take, takeLast, takeWhile, takeLastWhile
- Add samples for drop, dropLast, dropWhile, dropLastWhile
This commit is contained in:
gzoritchak
2018-02-20 00:45:48 +01:00
committed by Ilya Gorbunov
parent fda40723dc
commit 1c1fe10e12
8 changed files with 562 additions and 14 deletions
@@ -258,21 +258,29 @@ public expect inline fun <T> Iterable<T>.singleOrNull(predicate: (T) -> Boolean)
/**
* Returns a list containing all elements except first [n] elements.
*
* @sample samples.collections.Collections.Transformations.drop
*/
public expect fun <T> Iterable<T>.drop(n: Int): List<T>
/**
* Returns a list containing all elements except last [n] elements.
*
* @sample samples.collections.Collections.Transformations.drop
*/
public expect fun <T> List<T>.dropLast(n: Int): List<T>
/**
* Returns a list containing all elements except last elements that satisfy the given [predicate].
*
* @sample samples.collections.Collections.Transformations.drop
*/
public expect inline fun <T> List<T>.dropLastWhile(predicate: (T) -> Boolean): List<T>
/**
* Returns a list containing all elements except first elements that satisfy the given [predicate].
*
* @sample samples.collections.Collections.Transformations.drop
*/
public expect inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T>
@@ -342,21 +350,29 @@ public expect fun <T> List<T>.slice(indices: Iterable<Int>): List<T>
/**
* Returns a list containing first [n] elements.
*
* @sample samples.collections.Collections.Transformations.take
*/
public expect fun <T> Iterable<T>.take(n: Int): List<T>
/**
* Returns a list containing last [n] elements.
*
* @sample samples.collections.Collections.Transformations.take
*/
public expect fun <T> List<T>.takeLast(n: Int): List<T>
/**
* Returns a list containing last elements satisfying the given [predicate].
*
* @sample samples.collections.Collections.Transformations.take
*/
public expect inline fun <T> List<T>.takeLastWhile(predicate: (T) -> Boolean): List<T>
/**
* Returns a list containing first elements satisfying the given [predicate].
*
* @sample samples.collections.Collections.Transformations.take
*/
public expect inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T>