AutoBundle generates boilerplate code for field binding with android.os.Bundle.
Here is example for Fragment.
public class ExampleFragment extends Fragment {
// field with @Arg, must not be private/protected.
@Arg
String title;
@Arg
int exampleId;
@Arg(required = false) // default is true
int optionalId;
}
In caller section, you can use generated builder.
ExampleFragment fragment = ExampleFragmentAutoBundle
.createFragmentBuilder("hello, example!", 1)
.optionalId(2) // here is optional
.build();
Helper class is named {YourClass}AutoBundle.
FragmentBuilder also has method build(Fragment fragment),
so you can set bundle to existing instance.
For Intent, here is builder example.
Intent intent = ExampleActivityAutoBundle.createIntentBuilder("hello, example!")
.optionalName("optionalName")
.fooList(messages)
.build(this)
.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
AutoBundle supports Activity, BroadcastReceiver, Service.
Builder class has both methods build(Context context), build(Intent intent).
In target class,
public class ExampleFragment extends DialogFragment {
// field with @Arg, must not be private/protected.
@Arg
String title;
@Arg
int exampleId;
@Arg(required = false) // default is true
int optionalId;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
AutoBundle.bind(this);
}
}Call AutoBundle#bind in onCreate and bind value to field with @Arg.
In Intent case, call these method.
bind(Object target, Intent intent)bind(Object target, Bundle bundle)bind(Activity target)(equals tobind(activity, activity.getIntent())bind(Object target)(equals tobind(fragment, fragment.getArguments())
AutoBundle use reflection at the first time, to find generated class AutoBundleBindingDispatcher,
and call internal binding method for each classes.
(This idea from sockeqwe/FragmentArgs.)
key is key for Bundle. Default is field name.
You cannot define duplicate key in one class.
@Arg(key = "exampleId")
int id;
required option is true by default.
If false, Builder class has method which named key name, instead as contructor argument.
@Arg(required = false)
int optionalId;
then,
ExampleFragment fragment = ExampleFragmentAutoBundle
.createFragmentBuilder()
.optionalId(2)
.build();
converter option provide custom converter for storing to bundle.
You can specify class which implements Converter<T, U>.
public class ExampleFragment extends Fragment {
@Arg(converter = DateArgConverter.class)
Date targetDate;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
AutoBundle.bind(this);
}
public static class DateArgConverter implements Converter<Date, Long> {
@Override
public Long convert(Date o) {
return o.getTime();
}
@Override
public Date original(Long s) {
return new Date(s);
}
}
}
AutoBundle bindings are also useful as restoring value in onSaveInstanceState(Bundle outState).
@Override
public void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
AutoBundle.pack(this, outState);
}
pack(Object object, Bundle bundle) stores field value to bundle.
For example, store in onSaveInstanceState and restore in onCreate.
Both Fragment and Intent are able to pass value by storing Bundle.
There is a good pattern, known as "createIntent" or "newInstance". Static method in called class (e.x. Fragment, Activity) promised the expected data will be passed. AutBundle provide this pattern as builder method instead of "createIntent".
AutoBundle uses annotation processing, so you need to add android-apt plugin.
buildscript {
dependencies {
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
}
apply plugin: 'android-apt'
dependencies {
compile 'com.github.yatatsu:autobundle:0.2.0'
apt 'com.github.yatatsu:autobundle-processor:0.2.0'
}
Actually, AutoBundle is that just integrates above both great libraries.
Copyright 2015 KITAGAWA, Tatsuya
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.