Spot


Source link: https://github.com/kobakei/spot

Spot

Spot ( Shared Preferences Object Transformer) is Android object-data mapper for SharedPreferences.

Main features are as below:

  • No reflection: All repository classes will be generated by annotation processing.
  • POJO support: Entity classes do not need to inherit base class.
  • Store any types: By providing TypeConverter, any types can be stored.

Download

Project build.gradle

allprojects {

  repositories {

...

maven {
 url "https://jitpack.io" 
}

  
}
 
}

App build.gradle

dependencies {

  ...
  annotationProcessor 'com.github.kobakei.spot:compiler:LATEST_VERSION'
  compile 'com.github.kobakei.spot:library:LATEST_VERSION' 
}

LATEST_VERSION is

NOTE: if you use Android Gradle Plugin before 2.2.0, you must use android-apt plugin instead of annotationProcessor configuration.

Basic usage

Annotate your entity class with @Pref and fields with @PrefField.

@Pref(name = "foo") public class MyEntity {

 // Integer field
// defaultValue can be omitted.
@PrefField(name = "hoge")
public int hoge = 123;
 // String field
// defaultValue can be omitted.
@PrefField(name = "fuga")
public String fuga = "Hello";
 // Default constructor is needed.
public MyEntity() {

}
 
}

Once your build, MyEntitySpotRepository class will be generated in same package as entity class.

// Get MyEntity entity = MyEntitySpotRepository.getEntity(context);
  // Put entity.hoge = 123; entity.fuga = "Goodbye" MyEntitySpotRepository.putEntity(context, entity);

Type converter

Spot supports 6 types ( int, long, float, boolean, String and Set<String>) as fields but other types can also be supported by providing TypeConverter class.

For example, let's support java.util.Date class as entity field.

At first, subclass of TypeConverter is needed. The follow sample gets/puts Date value from SharedPreferences by converting from/to Long.

public class DateTypeConverter extends TypeConverter<Date, Long> {

  @Override
  public Date convertFromSupportedType(Long t) {

return new Date(t);

  
}

@Override
  public Long convertToSupportedType(Date t) {

return t.getTime();

  
}
 
}

At last, annotate Date field with converter option.

@Pref(name = "foo") public class MyEntity {

  @PrefField(name = "date", converter = DateTypeConverter.class)
  public Date date = new Date();
 
}

Kotlin

To work with Kotlin, please set true to useSetter and useGetter option.

@Pref(name = "MyModel") data class MyModel {

@PrefField(name = "foo", useSetter = true, useGetter = true)
var foo: Int = 0 
}

Migration from 1.0.0 or older versions

  • Replace @Pref*** with @PrefField
    • defaultValue is deprecated at v2 therefore put default value to field init value.
    // Before // @PrefInt(name = "foo", defaultValue = 123) // public int foo;
    // After @PrefField(name = "foo") public int foo = 123;  

Contribute this project

Small bug fixes are welcomed. If you want to add new feature, please raise issue.

License

Copyright 2016 Keisuke Kobayashi  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

A loading animation based on Floating Action Button.

Android LINQ is a small subset of collection manipulation utilities inspired by Microsoft C# LINQ library and targeted at Android developers looking to use new Java 8 Stream() API.

Customizable Calendar Widget for Android.

A plugin for Photoshop, Sketch, Xcode and Android Studio which in 1-click turns designs into assets, and shows color palettes, custom fonts and pixel perfect distances which can then be easily shared with the developer.

Android library for manipulating view touch targets using XML only.

MaterialContentOverflow is a ViewGroup that implements the Persistent Bottom Sheets pattern of Google Material Design.

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