Shade


Source link: https://github.com/t28hub/shade

Shade


Shade is a library makes SharedPreferences operation easy.

Table of Contents

Background

There might be a lot of boilerplate codes related to SharedPreferences operation in your Android application such as below. Writing boilerplate codes is boring stuff and a waste of time. In addition, it is necessary to review and test the bored codes. Shade can solve the problem. Shade generates codes related to SharedPreferences operation automatically once you only defines an interface or an abstract class. Generated codes run safe and fast because Shade does not use the Reflection.

Example

As you can see below, shade reduces a lot of boilerplate codes. In this example, user name and user age are stored into the SharedPreferences.

Before

Here is an example implementation before using Shade.

public class UserUtils {

  private static final String PREF_NAME = "io.t28.example.user";
  private static final String PREF_USER_NAME = "user_name";
  private static final String PREF_USER_NAME = "user_age";
  private static final String DEFAULT_USER_NAME = "guest";
  private static final int DEFAULT_USER_AGE = 20;

public static boolean hasName(Context context) {

return getSharedPreferences(context).contains(PREF_USER_NAME);

  
}

public static String getName(Context context) {

return getSharedPreferences(context).getString(PREF_USER_NAME, DEFAULT_USER_NAME);

  
}

public static void putName(Context context, String value) {

  getSharedPreferences(context).edit().putString(PREF_USER_NAME, value).apply();

  
}

public static void removeName(Context context) {

return getSharedPreferences(context).edit().remove(USER_NAME).apply();

  
}

public static boolean hasAge(Context context) {

return getSharedPreferences(context).contains(PREF_USER_AGE);

  
}

public static int getAge(Context context) {

return getSharedPreferences(context).getInt(PREF_USER_AGE, DEFAULT_USER_AGE);

  
}

public static void putAge(Context context, int value) {

return getSharedPreferences(context).edit().putInt(PREF_USER_AGE, value).apply();

  
}

public static void removeAge(Context context) {

return getSharedPreferences(context).edit().remove(PREF_USER_AGE).apply();

  
}

public static SharedPreferences getSharedPreferences(Context context) {

return context.getSharedPreferences(PREF_NAME, Cotnext.MODE_PRIVATE);

  
}
 
}

After

Here is an example implementation after using Shade.

@Preferences("io.t28.example.user") public interface class User {

  @Property(key = "user_name", defValue = "guest")
  String name();

@Property(key = "user_age", defValue = "20")
  int age();
 
}

Shade generates 3 classes.

  1. UserPreferences
  2. UserPreferences.Editor
  3. UserPreferences.UserImpl

You can use the generated classes as below.

// Instantiate the UserPreferences UserPreferences preferences = new UserPreferences(context);
  // Get preferences as a model User user = preference.get();
 // UserImpl{
name=guest, age=20
}
  // Check whether a specific preference is contained preferences.containsName();
 // false preferences.containsAge();
  // false  // Get a specific preference String name = preferences.getName();
 // guest int age = preferences.getAge();
 // 20  // Put a specific preference preferences.edit()

.putName("My name")

.putAge(30)

.apply();
  // Put a model User newUser = new UserPreferences.UserImpl("My name", 30);
 preferences.edit()

.put(newUser)

.apply();
  // Remove a specific preference preferences.edit()

.removeName()

.removeAge()

.apply();
  // Clear all preferences preferences.edit()

.clear()

.apply();

Installation

dependencies {

  compile 'io.t28:shade:0.9.0'
  annotationProcessor 'io.t28:shade-processor:0.9.0' 
}
 

Annotations

Shade provides only 2 annotations. One is @Preferences and the other is @Property.

@Preferences

@Preferences can be used to declare SharedPreferences model, and it can be annotated for an abstract class or an interface.

| Parameter | Type | Default Value | Description | |:---|:---|:---|:---|:---| | value | String | "" | Alias for name which allows to ignore name= part | | name | String | "" | The name of SharedPreferences | | mode | int | Context.MODE_PRIVATE | The operating mode of SharedPreferences |

Here is the example which uses io.t28.shade.example as a name and Context.MODE_PRIVATE as a mode.

@Preferences(name = "io.t28.shade.example", mode = Context.MODE_PRIVATE) public abstract class Example {
 
}

@Property

@Property can be used to declare SharedPreferences key, and it can be annotated for an abstract method.

| Parameter | Type | Default Value | Description | |:---|:---|:---|:---|:---| | value | String | "" | Alias for name which allows to ignore key= part | | key | String | "" | The key of the preference value | | defValue | String | "" | The default value for the key | | converter | Class<? extends Converter> | Converter.class | The converter that converts any value to supported value |

  • Either value or key must be specified.
  • defValue will be parsed as a type of return type.
  • For example, defValue will be parsed as boolean if a method annotated with @Property returns boolean value.
  • Converter is useful for you if you need to store unsupported type to the SharedPreferences.
  • The details of the Converter is mentioned in the below section.

Here is the example which used count as a key and 1 as a default value.

@Preferences public abstract class Example {

  @Property(key = "count", defValue = "1")
  public abstract int count();
 
}

The following default values are used if defValue is not specified.

Type Default value
boolean false
float 0.0f
int 0
long 0L
String ""
Set<String> Collections.emptySet()

Converter

SharedPreferences allows to store only 6 types as below.

  1. boolean
  2. float
  3. int
  4. long
  5. String
  6. Set<String>

Converter allows you to store unsupported types to SharedPreferences. You need to implement a converter which converts java.lang.Double to java.lang.Long, if you would like to use java.lang.Double. Here is an example implementation.

public class DoubleConverter implements Converter<Double, Long> {

  private static final double DEFAULT_VALUE = 0.0d;

@NonNull
  @Override
  public Double toConverted(@Nullable Long supported) {

if (supported == null) {

 return DEFAULT_VALUE;

}

return Double.longBitsToDouble(supported);

  
}

@NonNull
  @Override
  public Long toSupported(@Nullable Double converted) {

if (converted == null) {

 return Double.doubleToLongBits(DEFAULT_VALUE);

}

return Double.doubleToLongBits(converted);

  
}
 
}

Converter class should provide a default constructor.
toConverted should convert supported value to converted value and toSupported should convert converted value to supported value. You need to specify the DoubleConverter to the @Property such as below.

@Preferences public abstract class Example {

  @Property(key = "updated", converter = DoubleConverter.class)
  public abstract Date updated();
 
}

Troubleshooting

Feel free to ask me if there is any troubles.

License

Copyright (c) 2016 Tatsuya Maki  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. 

Resources

Easy font usage in your Android XML layouts

  • Based on Data Binding
  • Written in Kotlin
  • Automatic initialization
  • Automatic font caching
  • Homogeneous android:font usage
  • Tiny size: 14 KB
  • Minimum Android SDK: 7
  • Available through jCenter

Plugin for AndroidAnnotations allowing to use it together with PermissionsDispatcher. All you have to do is to include it in your dependencies.

A framework for building Mobile cross-platform UI.

A version info widget for Android with material style.

FogView is a android library that can show fog on any layout and the fog removes when user rubs it.

A custom Android TextView to display amounts of money in different formats.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes