Favor

A easy way of using Android SharedPreferences.

How to use this library

• Using Gradle

    compile 'com.cocosw:favor:0.2.0@aar'

• Using Maven

<dependency>
    <groupId>com.cocosw</groupId>
    <artifactId>favor</artifactId>
    <version>0.2.0</version>
    <type>apklib</type>
</dependency>

API

1 Define a interface.

@AllFavor
public interface Account {
    @Default("No Name")
    String getUserName();
    String setPassword(String password);
}

2 The FavorAdapter class generates an implementation of the interface.

account = new FavorAdapter.Builder(getContext()).build().create(Account.class);
account.setPassword("Passw0rd");
String username = account.getUserName();

API Declaration

@AllFavor

@AllFavor
public interface Account {
    @Default("No Name")
    String getUserName();
    String getPassword();
}

@Favor

    @Favor("city")
    @Default("Sydney")
    String city();

equals

    PreferenceManager.getDefaultSharedPreferences(context).getString("city","Sydney");

And you can simplify it, Favor will extract the key from the method name

    @Favor
    @Default("Sydney")
    String city();

@Default

    @Default("18")
    int age();
    
    @Default("true")
    boolean alive();

@Commit

By default, Favor will call editor.apply() (>api9), but you can force it to use editor.commit() by @Commit

    @Favor
    @Commit
    void setAddress(String address);

RxPreference

You are a RxJava fan, easy! (rx-preferences dependency is required)

    @Favor
    @Default("No Name")
    Preference<String> name();

Advanced usage

Favor support put/get all primitive types, including int/long/float/String/bool, String set is also supported for API>=11. From 0.2.0, Favor (Experimentally) supports Serializable object saving/loading.

    public class Image implements Serializable {
    ....
    }
   
    @Favor
    Image image();

    @Favor
    void setImage(Image image);

There is one limitation that you can't set default value for Serializable preference item.

Proguard

# Favor
-dontwarn com.cocosw.favor.** { *; }
-keep class com.cocosw.favor.** { *; }

Contribute

• Feel free to send your pull request to me.

License

Copyright 2011, 2015 Kai Liao

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.