Android processing and secured library for managing SharedPreferences as key-value elements efficiently and structurally.
Memo Library is available through Maven Repository. To use it:
- Open the
build.gradlefile for your application. - Make sure that the
repositoriessection includes Maven RepositorymavenCentral(). For example:
allprojects {
repositories {
mavenCentral()
}
}- Add the library to the
dependenciessection:
dependencies {
// ...
// declare memo version
def memo_version = "x.y.z"
// Memo Library
implementation("com.zeoflow.memo:memo:$memo_version")
// Required if you want to use the injector
implementation("com.zeoflow.memo:memo-runtime:$memo_version")
annotationProcessor("com.zeoflow.memo:memo-compiler:$memo_version")
// For kotlin projects use kapt instead of annotationProcessor
kapt("com.zeoflow.memo:memo-compiler-ktx:$memo_version")
// ...
}With Context
Memo.init(context).build();Without Context (the context is retrieved from the ContextProvider at runtime)
Memo.init().build();Save any type (Any object, primitives, lists, sets, maps ...)
Memo.put(key, T);Get the original value with the original type
T value = Memo.get(key);Delete any entry
Memo.delete(key);Check if any key exists
Memo.contains(key);Check total entry count
Memo.count();Delete everything
Memo.deleteAll();- Everything is pluggable, therefore you can change any layer with your custom implementation.
- NoEncryption implementation is provided out of box If you want to disable crypto.
Memo.init(context)
.setEncryption(new NoEncryption())
// encryption_string is used to encrypt the data and is required
.setEncryption(new ConcealEncryption(encryption_string))
.setLogInterceptor(new MyLogInterceptor())
.setConverter(new MyConverter())
.setParser(new MyParser())
.setStorage(new MyStorage())
.build();/**
* the entity generated will be named UserProfile_MemoEntity
* it was annotated with @MemoEntity("UserProfile")
*
* the entity will be encrypted using the "G15y3aV9M8d" key
* it was annotated with @EncryptEntity("G15y3aV9M8d")
*/
@MemoEntity("UserProfile")
@EncryptEntity("G15y3aV9M8d")
public class User
{
/**
* the default value will be "zeoflow"
*
* generated field will be named username
*
* this field is observable
* it was annotated with @Observable
*/
@KeyName("username")
@Observable
protected final String userUsername = "zeoflow";
/**
* generated field name will be login - lowerCamel
*
* this field will have its own onChangedListener
* it was annotated with @Listener
*/
@Listener
protected final boolean login = false;
/* the default value will be 1 */
@KeyName("views")
protected final int viewsCount = 1;
/* the default value will be null */
@KeyName("userinfo")
protected PrivateInfo privateInfo;
/**
* preference putter function for userUsername.
*
* @param userUsername function in
*
* @return function out
*/
@MemoFunction("username")
public String putUserUsernameFunction(String userUsername)
{
return "Hello, " + userUsername;
}
/**
* preference getter function for userUsername.
*
* @param userUsername function in
*
* @return function out
*/
@MemoFunction("username")
public String getUserUsernameFunction(String userUsername)
{
return userUsername + "!!!";
}
/**
* preference putter function example for visitCount's auto increment.
*
* @param count function in
*
* @return function out
*/
@MemoFunction("views")
public int putVisitCountFunction(int count)
{
return ++count;
}
/**
* preference getter compound function for following fields.
*
* Params declared inside @MemoCompoundFunction's annotation
* @param username function in
* @param views function in
*
* @return $username $views
*/
@MemoCompoundFunction(values = {"username", "views"})
public String getUserViews(String username, int views)
{
return username + " " + views;
}
/**
* preference getter compound function for following fields.
*
* Params declared inside @MemoCompoundFunction's annotation
* @param userinfo function in
*
* @return $first_name $last_name
*/
@MemoCompoundFunction(values = {"userinfo"})
public String getFullName(PrivateInfo userinfo)
{
return userinfo.getFirstName() + " " + userinfo.getLastName();
}
/**
* preference getter compound function for following fields.
*
* Params declared inside @MemoCompoundFunction's annotation
* @param userinfo function in
* @param views function in
*
* @return $first_name $last_name, views count $views
*/
@MemoCompoundFunction(values = {"userinfo", "views"})
public String getFullNameAndViews(PrivateInfo userinfo, int views)
{
return userinfo.getFirstName() + " " + userinfo.getLastName() + ", views count: " + views;
}
}Create injector class
/**
* Component that integrates memo entities; it must be an interface
* and annotated with @MemoComponent. The generated class will end in
* $_Memo (generated class for this interface will be AppStorage_Memo
*
* inside this Memo manager, the following MemoEntities are injected:
* - User
* - Country
*/
@MemoComponent(entities = {User.class, Country.class})
public interface AppStorage
{
/**
* declare dependency injection target MaiActivity.
*/
void inject(MainActivity mainActivity);
/**
* declare dependency injection target LoginActivity.
*/
void inject(LoginActivity loginActivity);
}Create variables that needs to be injected by the AppStorage_Memo
@InjectPreference
public AppStorage_Memo component;
@InjectPreference
public UserProfile_MemoEntity userProfile;Inject MainActivity in the AppStorage_Memo
AppStorage_Memo.getInstance().inject((MainActivity) this);Access MemoEntity from Memo Component
component.userProfile();Put value inside userProfile
userProfile.putUsername(inputUsername);Add change listener for login
userProfile.addLoginListeners(new UserProfile_MemoEntity.LoginIOnChangedListener()
{
@Override
public void onChanged(boolean login)
{
// do something
}
});Add observable for the username field
component.userProfile().usernameObserver((LifecycleOwner) this, new Observer<String>()
{
@Override
public void onChanged(String username)
{
// do something here
}
});Copyright (C) 2021 ZeoFlow S.R.L.
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.
