Typed Preferences

This library for Android provides classes which allow to store and retrieve settings from the preferences. There is an individual class for each native type:

• BooleanPreference for a boolean value
• DoublePreference for a double value
• FloatPreference for a float value
• IntPreference for an int value
• LongPreference for a long value
• ShortPreference for a short value
• StringPreference for a String value

Each class comes with two constructors - one of them allows to ommit the default value.

All classes declare the same methods: get(), isSet(), set() and delete(). Here are the method signatures as definied in the StringPreference class.

public class StringPreference {
    public String get() { ... }
    public boolean isSet() { ... }
    public void set(String value) { ... }
    public void delete() { ... }
}

Wrappers for frequently used classes can be found and added in the wiki. Take a look!

How to get the thing running?

Add the library as a dependency to your build.gradle in case you use Gradle:

dependencies {
    compile "info.metadude.android:typed-preferences:{$version}"
}

Or if you use Maven you should be looking for this:

<dependency>
    <groupId>info.metadude.android</groupId>
    <artifactId>typed-preferences</artifactId>
    <version>{$version}</version>
</dependency>

For anything else, go to Maven Central - or just build the library yourself.

Minimum SDK version / API level

The library is available in two different versions. If you need to support API level 8 in your project you must include the latest 1.x.x version. This library version persists the settings synchronously using the commit method of the SharedPreferences.Editor. If the minimum SDK version you need to support is API level 9 you can choose the latest 2.x.x version which relies on the apply method of the SharedPreferences.Editor. Thereby settings are persisted asynchronously.

For further information please stick to documentation of the SharedPreferences.Editor interface.

Demo project

Check out the demo project TypedPreferencesDemo which shows how to use the library.

Tests

Run ./gradlew clean test to execute the tests.

Feedback

If you use this library and you are happy with it please send a tweet to @tbsprs and feel free to announce your app. I will be happy to list it here.

In case you do not like the library please do not hesitate to open an issue and let me know what can be improved.

Which applications are using this library?

• android-rss-reader
• Hawkular Android Client
• MuzeiHistory
• Philips Hue Beacon Controller
• yacc

Reference

This library is mainly inspired by the classes which have been published by Jake Wharton in the u2020 project.

Authors

• Tobias Preuss

Contributors

• Daniel Beland
• ligi
• Marius Volkhart
• Matthew Compton

License

Copyright 2014-2018 Tobias Preuss

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.