Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KeithYokoma/Fit
Framework for dispatching various procedure on update application.
https://github.com/KeithYokoma/Fit
Last synced: about 2 months ago
JSON representation
Framework for dispatching various procedure on update application.
- Host: GitHub
- URL: https://github.com/KeithYokoma/Fit
- Owner: KeithYokoma
- License: apache-2.0
- Created: 2014-06-25T02:02:06.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-08-14T01:15:28.000Z (over 6 years ago)
- Last Synced: 2024-11-25T02:14:42.440Z (2 months ago)
- Language: Java
- Homepage:
- Size: 137 KB
- Stars: 59
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-android - Fit - version checking callback framework with no UI. (Libraries / Version Checking)
- awesome-android-libraries - Fit
- awesome-android - Fit - version checking callback framework with no UI. (Libraries / Version Checking)
README
# Fit
[](https://gitter.im/KeithYokoma/Fit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://android-arsenal.com/details/1/1174)
[](https://github.com/KeithYokoma/Fit/blob/master/LICENSE.md)
[](https://circleci.com/gh/KeithYokoma/Fit.svg?style=shield)
Framework for dispatching various procedure on update application.
[Photo License CC by NC-ND](https://creativecommons.org/licenses/by-nc-nd/2.0/)
# Attention
This library is under development so API may be changed drastically until the first major release.
# Usage
Prepare `VersionModule` to declare what to do when your application is upgraded or newly installed.
```java
public class MyModule implements VersionModule {
@VersionCode({1, 2, 3}) // foo() is called when the app is updated to version code = 1, 2 and 3
public void foo() {
}
@VersionCode(4) // bar() is called when the app is updated to version code = 4
public void bar() {
}
}
```
If you like to have them executed only when it is an upgrade, use `UpgradeOnly` annotation.
```java
public class MyModule implements VersionModule {
@VersionCode({1, 2, 3}) // foo() is called when the app is updated to version code = 1, 2 and 3
public void foo() {
}
@VersionCode(4)
@UpgradeOnly // bar() is called when the app is updated to version code = 4, and not called when the app is newly installed
public void bar() {
}
}
```
Register your `VersionModule` when `Application#onCreate()` called.
```java
public class MyApp extends Application {
@Override
public void onCreate() {
super.onCreate();
Fit.initialize(this, new MyModule());
}
}
```
And execute update procedure like this.
```java
Fit.getInstance().execute();
```
Currently `Fit` has a synchronous call interface only.
Asynchronous call will be introduced in the near future.
# ProGuard Settings
Set configuration for ProGuard to keep annotation and annotated methods.
```java
-keepattributes *Annotation*
-keepclassmembers class * {
@jp.yokomark.fit.VersionCode *;
}
```
# License
Apache License v2
```
Copyright (C) 2014 KeithYokoma, Inc. All rights reserved.
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.
```