Alfred


Source link: https://github.com/MrHadiSatrio/Alfred

Alfred – Android ViewModel instantiation made effortless

Why should I use it?

// It's so you can just do this...

  SomeViewModel viewModel = SomeViewModelProvider.get(this, "...", 0L);
// Instead this...

  SomeViewModel viewModel = SomeViewModelProviders.of(this).get(SomeViewModel.class);

 viewModel.setMessage("...");

 viewModel.setEffGiven(1L);
// Or this...

  SomeViewModel viewModel = ViewModelProviders.of(this, new CustomViewModelFactory("...", 1000L)).get(SomeViewModel.class);

  ...

  public final class CustomViewModelFactory implements ViewModelProvider.Factory {

// About 28 lines of code here (given your ViewModel takes 2 arguments like above).
 
}

Usage guide

Getting Alfred to simplify your ViewModel instantiation is simple:

  1. Make sure your ViewModel has a constructor containing all the things it needs supplied as parameters:
public final class SomeViewModel extends ViewModel {

  private final int someInt;

 private final String someString;

 private final SomeClass someClass;

  public SomeViewModel(int anInt, String aString, SomeClass yourClass) {

 // Initiate the fields..

 
}

  ...
 
}
  1. Annotate the class with @GeneratedProvider:
@GeneratedProvider
 public final class SomeViewModel extends ViewModel {

 ...
 
}
  1. Build and voila!
SomeViewModel viewModel = SomeViewModelProvider.get(99, "Problems", new ViewModelsAintOne());

Current limitation

As of its current state, Alfred is limited to process only the first constructor declared on each ViewModel. You could override this behavior by explicitly annotating the constructor you want it to process instead with @Main:

@GeneratedProvider
 public final class SomeViewModel extends ViewModel {

  private final int someInt;

 private final String someString;

 private final SomeClass someClass;

 private final SomeEnum someEnum;

  public SomeViewModel(int anInt, String aString, SomeClass yourClass) {

 this(anInt, aString, yourClass, SomeEnum.NONE);

 
}

  @Main /* Tells Alfred to process this instead of the first one above. */

 public SomeViewModel(int anInt, String aString, SomeClass yourClass, SomeEnum someEnum) {

 ...

 
}

  ...
 
}

Please note that there could only be one @Main-annotated constructor declared in your ViewModel.

Including Alfred to your project

Include Alfred to your Gradle project by adding it as a dependency in your build.gradle:

apply plugin: 'com.neenbedankt.android-apt'
  repositories {

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

 
}

  dependencies {

  compile 'com.hadisatrio.Alfred:annotations:v1.0.0-RC.3'

  apt 'com.hadisatrio.Alfred:compiler:v1.0.0-RC.3'
 
}

You'll also need android-apt in your project. See how to do it here.

Contributions

Any kind of contribution will be appreciated. PR away!

License

Alfred is published under the Apache License 2.0.


p.s., Please let me know if you're using Alfred in your projects. Drop an email at hi[you-know-what-to-put-here]hadisatrio.com. ;)

Resources

Library for passing arguments into Fragment.

Local network library for connecting Android devices on WiFi. One device serves as a server, others are clients. Library takes care of discovery of server by clients and it uses services and separate threads with sockets to handle communication.

Analytics framework for Android.

This is a sample project showing an implementation of mini navigation drawer for Android.

An implementation of tap targets from the Material Design guidelines for feature discovery.

Day or night switch-button.

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