Skip to content

Commit 4e71f32

Browse files
committed
v2.0.0
1 parent a185375 commit 4e71f32

File tree

113 files changed

+10628
-181
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+10628
-181
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<!-- for main -->
2-
3-
[![Download](https://img.shields.io/badge/Download-1.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/1.2.0)
2+
<!--
3+
[![Download](https://img.shields.io/badge/Download-2.0.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.0.0)
44
[![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
55
[![Build Status Ubuntu](https://github.com/robstoll/kbox/workflows/Ubuntu/badge.svg?event=push)](https://github.com/robstoll/kbox/actions?query=workflow%3AUbuntu+branch%3Amain)
66
[![Build Status Windows](https://github.com/robstoll/kbox/workflows/Windows/badge.svg?event=push)](https://github.com/robstoll/kbox/actions?query=workflow%3AWindows+branch%3Amain)
7-
7+
-->
88

99
<!-- for a specific release -->
10-
<!--
11-
[![Download](https://img.shields.io/badge/Download-1.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/1.2.0)
10+
11+
[![Download](https://img.shields.io/badge/Download-2.0.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.0.0)
1212
[![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
13-
-->
13+
1414

1515
# KBox
1616
KBox is a very small but useful utility library for Kotlin (JVM, Android and JS) providing functions which are missing
@@ -32,7 +32,7 @@ KBox is published to maven central.
3232
```
3333
repositories { mavenCentral() }
3434
dependencies {
35-
implementation("ch.tutteli.kbox:kbox:1.2.0")
35+
implementation("ch.tutteli.kbox:kbox:2.0.0")
3636
}
3737
```
3838

build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import java.nio.file.StandardCopyOption
55
buildscript {
66
// needs to be defined in here because otherwise tutteli-publish plugin does not have this information when applied
77
// and we want that it to apply the ch.tutteli conventions
8-
rootProject.version = "1.3.0-SNAPSHOT"
8+
rootProject.version = "2.0.0"
99
rootProject.group = "ch.tutteli.kbox"
1010
rootProject.description = "A utility library for Kotlin"
1111
extra.set("generationFolder", project.files("src/commonMain/generated/kotlin"))

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Download](https://img.shields.io/badge/Download-1.2.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/1.2.0)
1+
[![Download](https://img.shields.io/badge/Download-2.0.0-%23007ec6)](https://central.sonatype.com/artifact/ch.tutteli.kbox/kbox/2.0.0)
22
[![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)
33

44
# KBox
@@ -11,7 +11,7 @@ KBox is published to maven central.
1111
```
1212
repositories { mavenCentral() }
1313
dependencies {
14-
implementation("ch.tutteli.kbox:kbox:1.2.0")
14+
implementation("ch.tutteli.kbox:kbox:2.0.0")
1515
}
1616
```
1717

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>JvmSynchronized</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../../index.html">
44+
KBox
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
2.0.0 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
52+
<button class="platform-tag platform-selector js-like" data-active="" data-filter=":dokkaHtml/jsMain">js</button>
53+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/jvmMain">jvm</button>
54+
</div>
55+
</div>
56+
<div class="navigation-controls">
57+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
58+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
59+
</div>
60+
</nav>
61+
<div id="container">
62+
<div class="sidebar" id="leftColumn">
63+
<div class="sidebar--inner" id="sideMenu"></div>
64+
</div>
65+
<div id="main">
66+
<div class="main-content" data-page-type="classlike" id="content" pageIds="KBox::ch.tutteli.kbox/JvmSynchronized///PointingToDeclaration//-712551682">
67+
<div class="breadcrumbs"><a href="../../../index.html">KBox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><span class="current">JvmSynchronized</span></div>
68+
<div class="cover ">
69+
<h1 class="cover"><span>Jvm</span><wbr></wbr><span><span>Synchronized</span></span></h1>
70+
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
71+
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain" data-active="" data-toggle=":dokkaHtml/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":dokkaHtml/jsMain" data-filterable-set=":dokkaHtml/jsMain" data-toggle=":dokkaHtml/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":dokkaHtml/jvmMain" data-filterable-set=":dokkaHtml/jvmMain" data-toggle=":dokkaHtml/jvmMain">jvm</button></div>
72+
<div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html">AnnotationTarget.FUNCTION</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-g-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_GETTER</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-s-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_SETTER</a></span><wbr></wbr><span class="token punctuation">]</span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">expect </span><span class="token keyword">annotation class </span><a href="index.html">JvmSynchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.0.0/src/commonMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L8">source</a>)</span></span></div><p class="paragraph">Stands for <code class="lang-kotlin">kotlin.jvm.Synchronized</code> on the JVM platform and a dummy annotation on the other platforms.</p></div><div class="content sourceset-dependent-content" data-togglable=":dokkaHtml/jsMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html">AnnotationTarget.FUNCTION</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-g-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_GETTER</a><span class="token punctuation">, </span></span><wbr></wbr><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y_-s-e-t-t-e-r/index.html">AnnotationTarget.PROPERTY_SETTER</a></span><wbr></wbr><span class="token punctuation">]</span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">actual </span><span class="token keyword">annotation class </span><a href="index.html">JvmSynchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.0.0/src/jsMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L8">source</a>)</span></span></div><p class="paragraph">Without any effects on the JS Platform.</p></div><div class="content sourceset-dependent-content" data-togglable=":dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">typealias </span><a href="index.html">JvmSynchronized</a><span class="token operator"> = </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.0.0/src/jvmMain/kotlin/ch/tutteli/kbox/JvmSynchronized.kt#L6">source</a>)</span></span></div><p class="paragraph">Typealias for <code class="lang-kotlin">kotlin.jvm.Synchronized</code>.</p></div> </div>
73+
</div>
74+
<div class="tabbedcontent">
75+
<div class="tabs-section" tabs-section="tabs-section"></div>
76+
<div class="tabs-section-body"></div>
77+
</div>
78+
</div>
79+
<div class="footer">
80+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>KBox &copy; Copyright Robert Stoll &lt;rstoll@tutteli.ch&gt;</span><span
81+
class="pull-right"><span>Generated by </span><a
82+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
83+
</div>
84+
</div>
85+
</div>
86+
</div>
87+
</body>
88+
</html>
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>Companion</title>
6+
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../../../index.html">
44+
KBox
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
2.0.0 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="classlike" id="content" pageIds="KBox::ch.tutteli.kbox/PeekingIterator.Companion///PointingToDeclaration//788909594">
65+
<div class="breadcrumbs"><a href="../../../../index.html">KBox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">PeekingIterator</a><span class="delimiter">/</span><span class="current">Companion</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span><span>Companion</span></span></h1>
68+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v2.0.0/src/commonMain/kotlin/ch/tutteli/kbox/PeekingIterator.kt#L16">source</a>)</span></span></div><p class="paragraph">Necessary so that extension methods can extend it.</p></div></div>
69+
</div>
70+
<div class="tabbedcontent">
71+
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
72+
<div class="tabs-section-body">
73+
<div data-togglable="FUNCTION">
74+
<h2 class="">Functions</h2>
75+
<div class="table"><a data-name="-1708835953%2FFunctions%2F788909594" anchor-label="invoke" id="-1708835953%2FFunctions%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
76+
<div class="table-row" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
77+
<div class="main-subrow keyValue ">
78+
<div class=""><span class="inline-flex">
79+
<div><a href="invoke.html"><span><span>invoke</span></span></a></div>
80+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1708835953%2FFunctions%2F788909594"></span>
81+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
82+
</span></span></div>
83+
<div>
84+
<div class="title">
85+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">operator </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">itr<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterator/index.html">Iterator</a><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">PeekingIterator</a><span class="token operator">&lt;</span><a href="invoke.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Platform independent method which creates a <a href="../index.html">PeekingIterator</a> based on a given <a href="invoke.html">itr</a>.</p></div></div></div>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
</div>
91+
</div>
92+
</div>
93+
</div>
94+
</div>
95+
<div class="footer">
96+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>KBox &copy; Copyright Robert Stoll &lt;rstoll@tutteli.ch&gt;</span><span
97+
class="pull-right"><span>Generated by </span><a
98+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
99+
</div>
100+
</div>
101+
</div>
102+
</div>
103+
</body>
104+
</html>

0 commit comments

Comments
 (0)