mskn73 / kache

Simple cache implemented in kotlin

KACHE a Cache lib made with Kotlin

Still in development

Add the dependency

1. Add jitpack in your root build.gradle at the end of repositories

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

2. Add the dependency

dependencies {
  compile "com.github.mskn73:kache:${kacheVersion}"
}

How to use

Kotlin example

1. Implement the Kacheable interface for your class

internal inner class MyObject(override val key: String) : Kacheable

If you want to specifies the expiration time, annotates the class with `KacheLife:

@KacheLife(expiresTime = (60 * 1000).toLong())
internal inner class MyObject(override val key: String) : Kacheable

2. Save and retrieve the object:

//Instantiate Kache
val k = Kache(applicationContext, cacheDir.toString())
//Save data
k.put(MyObject("[e-mail]"))
//Get the data
val myKachedObject = k.get(MyObject::class.java, "[e-mail]") as Kacheable

Java example

1. Implement the Kacheable interface for your class

class MyObject implements Kacheable {
  private final String mail;

  public MyObject(String mail) {
    this.mail = mail;
  }

  @NotNull @Override public String getKey() {
    return mail;
  }
}

If you want to specifies the expiration time, annotates the class with `KacheLife:

@KacheLife(expiresTime = 60 * 1000)
class MyObject implements Kacheable {
  private final String mail;

  public MyObject(String mail) {
    this.mail = mail;
  }

  @NotNull @Override public String getKey() {
    return mail;
  }
}

2. Save and retrieve the object:

//Instantiate Kache
Kache k = new Kache(getApplicationContext(), getCacheDir().toString());
//Save data
k.put(new MyObject("[e-mail]"));
//Get the data
Kacheable myKachedObject = (Kacheable) k.get(MyObject.class, "[e-mail]");