๐ An easy way to persist and run code block only as many times as necessary on Android.
Add a dependency code to your module's build.gradle
file.
dependencies {
implementation "com.github.skydoves:only:1.0.6"
}
First, initialize the Only
using init()
method like below.
This code can be initialized on Application
class only once.
Only.init(context)
Below codes will run the showIntroPopup()
only three times using onDo
method.
Only.onDo("introPopup", times = 3) {
showIntroPopup()
}
// kotlin dsl
only("introPopup", times = 3) {
onDo { showIntroPopup() }
}
Below codes will run the doSomethingAfterDone()
and toast("done")
after run the onDo
block codes three times.
Only.onDo("introPopup", times = 3,
onDo = {
showIntroPopup()
toast("onDo only three times")
},
onDone = {
doSomethingAfterDone()
toast("done")
})
// kotlin dsl
only("introPopup", times = 3) {
onDo {
showIntroPopup()
toast("onDo only three times")
}
onDone {
doSomeThingAfterDone()
toast("done")
}
}
We can do pre and post-processing using onLastDo
, onBeforeDone
options.
only("Intro", times = 3) {
onDo {
showIntroPopup()
toast("onDo only three times")
}
onLastDo { // executes only once after finished onDo block 3 times.
toast("finished onDo")
}
onBeforeDone { // executes only once before run onDone block.
toast("starts onDo")
}
onDone {
doSomethingAfterDone()
toast("done")
}
}
We can apply it for repeating x times.
Below codes shows review-popup 3 times and checks the user reviewed or not in onLastDo
block.
If not, clear times using the Only.clearOnly
method, and repeat it the first time again.
only("Intro", times = 3) {
onDo { showReviewRequestPopup() }
onLastDo { // executes only once after finished onDo block 3 times.
if (!isRequested) {
Only.clearOnly(this@only.name)
}
}
}
We can renew the persistence times for controlling the version using version
option.
If the version is different from the old version, run times will be initialized 0.
Only.onDo("introPopup", times = 3,
onDo = { showIntroPopup() },
onDone = { doSomethingAfterDone() },
version = BuildConfig.VERSION_NAME // we can set manually. e.g. "1.1.1.1"
)
// kotlin dsl
only("introPopup", times = 3) {
onDo { showIntroPopup() }
onDone { doSomethingAfterDone() }
version("1.1.1.1")
}
We can run Only using Only.Builder
class like below.
Only.Builder("introPopup", times = 3)
.onDo { showIntroPopup() }
.onDone { doSomethingAfterDone() }
.version(BuildConfig.VERSION_NAME)
.run()
Here is some useful kotlin-dsl functions.
onlyOnce("onlyOnce") { // run the onDo block codes only once.
onDo { doSomethingOnlyOnce() }
onDone { doSomethingAfterDone() }
}
onlyTwice("onlyTwice") { // run the onDo block codes only twice.
onDo { doSomethingOnlyTwice() }
onDone { doSomethingAfterDone() }
}
onlyThrice("onlyThrice") { // run the onDo block codes only three times.
onDo { doSomethingOnlyThrice() }
onDone { doSomethingAfterDone() }
version("1.1.1.1")
}
We can optionally delete the stored Only
target data or delete the whole Only
data.
Only.clearOnly("introPopup") // clears a saved target Only data.
Only.clearAllOnly() // clears all of the target Only data on the application.
Below codes will show the button
view only once.
button.onlyVisibility(name = "myButton", times = 1, visible = true)
Below codes will show toast only x times.
onlyToast("toast", 3, "This toast will be shown only three times.")
onlyOnceToast("toast1", "This toast will be shown only once.")
onlyTwiceToast("toast2", "This toast will be shown only twice.")
onlyThriceToast("toast3", "This toast will be shown only thrice.")
We can mark data to the Only target.
only("introPopup", times = 3) {
onDo { showIntroPopup() }
onDone { doSomethingAfterDone() }
mark("abc") // marks only once when run by kotlin dsl or builder class.
}
Only.mark("introPopup", 3) // changes marking using mark method.
val marking = Only.getMarking("introPopup") // gets the marked data.
Sometimes on debug, we don't need to persist data and replay onDone block.
onlyOnDoDebugMode
helps that ignore persistence data and onDone block when initialization. It runs only onDo block.
val only = Only.init(application)
if (BuildConfig.DEBUG) {
only.onlyOnDoDebugMode(true)
}
Here are some usages for Java developers.
int times = Only.getOnlyTimes("IntroPopup") ;
if (times < 3) {
Only.setOnlyTimes("IntroPopup", times + 1);
showIntroPopup();
}
we can run Only
in java project using Only.Builder
and Runnable
.
new Only.Builder("introPopup", 1)
.onDo(new Runnable() {
@Override
public void run() {
doSomethingOnlyOnce();
}
})
.onDone(new Runnable() {
@Override
public void run() {
doSOmethingAfterDone();
}
}).run(); // run the Only
We can make it more simple using Java8 lambda expression.
Add below codes on your build.gradle
file.
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
Then you can run the Only like below.
new Only.Builder("introPopup", 1)
.onDo(() -> {
doSomethingOnlyOnce();
})
.onDone(() -> {
doSOmethingAfterDone();
}).run(); // run the Only
We can create custom util class like what Kotlin's onlyOnce
.
public class OnlyUtils {
public static void onlyOnce(
String name, Runnable runnableOnDo, Runnable runnableOnDone) {
new Only.Builder(name, 1)
.onDo(runnableOnDo)
.onDone(runnableOnDone)
.run(); // run the Only
}
}
Support it by joining stargazers for this repository. โญ
And follow me for my next creations! ๐คฉ
Copyright 2019 skydoves (Jaewoong Eum)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.