README.md

Rocket 🚀 🚀 🚀

A SharedPreferences library for Android , to speed up development. Since I always have to write this class in every project now anyone can use it. Added some extra functionality, wrote tests and it's good to go for anyone.

KotlinDoc: https://coroutinedispatcher.github.io/rocket/

Download

Step 1. Add the jcenter() repository to your build file

Add it in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		jcenter()
	}
}

Step 2. Add the dependency

implementation 'com.stavro_xhardha.rocket:rocket:2.2.3'

Usage

fun writeData(data: String){
 rocketInstance.writeString(DATA_KEY, data)
}

Set up

Just call the rocket instance like :

private val rocket = Rocket.launch(mContext, SHARED_PREFERENCES_FILE_NAME , Context.MODE_PRIVATE)

Saving a value :

rocket.writeString(YOUR_DESIRED_KEY_NAME , YOUR_DESIRED_VALUE)

Reading a value :

rocket.readString(YOUR_DESIRED_KEY_NAME , YOUR_DESIRED_VALUE)

Deleting all saved SharedPreferences :

rocket.crash()

Deleting one particular value :

rocket.drop(YOUR_DESIRED_KEY)

Deleting desired values

rocket.drop(YOUR_DESIRED_KEY_ONE, YOUR_DESIRED_KEY_TWO, YOUR_DESIRED_KEY_THREE)

Note : The Mode is by default Context.MODE_PRIVATE , if you want to specify different mode , apply it as a third parameter in the launch() method

Extension functions:

SOME_INT_KEY.isDefaultInt(rocketInstance)

Please read the docs for more information about all methods

Licence

Copyright 2019 stavro96.

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.