Add onCreate method to ViewModel

Daniel Novak · Daniel Novak · commit be3a2a65575a · 2015-05-09T23:49:50.000+02:00
diff --git a/library/src/main/java/eu/inloop/viewmodel/AbstractViewModel.java b/library/src/main/java/eu/inloop/viewmodel/AbstractViewModel.java
@@ -1,8 +1,11 @@
 package eu.inloop.viewmodel;
 
+import android.app.Activity;
+import android.content.Intent;
 import android.os.Bundle;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.support.v4.app.Fragment;
 
 import eu.inloop.viewmodel.IView;
 
@@ -26,6 +29,18 @@ public int getUniqueIdentifier() {
         return mUniqueIdentifier;
     }
 
+    /**
+     * @param arguments initial ViewModel arguments passed from {@link Fragment#getArguments()}  or
+     *                  {@link Activity#getIntent()}.{@link Intent#getExtras()}
+     * @param savedInstanceState bundle with saved state, will be not null
+     *               only in case the system is killed due to low memory
+     *               and restored (and {@link #saveState(Bundle)} returned a non-null bundle.
+     */
+    @SuppressWarnings("EmptyMethod")
+    public void onCreate(@Nullable Bundle arguments, @Nullable Bundle savedInstanceState) {
+
+    }
+
     public void initWithView(@NonNull T view) {
         mView = view;
     }
@@ -43,15 +58,6 @@ public void saveState(Bundle bundle) {
 
     }
 
-    /**
-     * Will be called only in case the system is killed due to low memory and restored
-     * @param bundle - bundle with saved state
-     */
-    @SuppressWarnings("EmptyMethod")
-    public void restoreState(Bundle bundle) {
-
-    }
-
     @SuppressWarnings("EmptyMethod")
     public void onStop() {
 
diff --git a/library/src/main/java/eu/inloop/viewmodel/ViewModelHelper.java b/library/src/main/java/eu/inloop/viewmodel/ViewModelHelper.java
@@ -1,6 +1,7 @@
 package eu.inloop.viewmodel;
 
 import android.app.Activity;
+import android.content.Intent;
 import android.os.Bundle;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
@@ -20,11 +21,15 @@ public class ViewModelHelper<T extends IView, R extends AbstractViewModel<T>> {
     /**
      * Call from {@link android.app.Activity#onCreate(android.os.Bundle)} or
      * {@link android.support.v4.app.Fragment#onCreate(android.os.Bundle)}
-     * @param savedInstanceState
-     * @param viewModelClass
+     * @param savedInstanceState savedInstance state from {@link Activity#onCreate(Bundle)} or
+     *                           {@link Fragment#onCreate(Bundle)}
+     * @param viewModelClass the {@link Class} of your ViewModel
+     * @param arguments pass {@link Fragment#getArguments()}  or
+     *                  {@link Activity#getIntent()}.{@link Intent#getExtras() getExtras()}
      */
     public void onCreate(@Nullable Bundle savedInstanceState,
-                         @Nullable Class<? extends AbstractViewModel<T>> viewModelClass) {
+                         @Nullable Class<? extends AbstractViewModel<T>> viewModelClass,
+                         @Nullable Bundle arguments) {
         // no viewmodel for this fragment
         if (viewModelClass == null) {
             mViewModel = null;
@@ -44,12 +49,12 @@ public void onCreate(@Nullable Bundle savedInstanceState,
         //noinspection unchecked
         mViewModel = (R) viewModelWrapper.viewModel;
 
-        // detect that the system has killed the app - saved instance is not null, but the model was recreated
-        if (savedInstanceState != null && viewModelWrapper.wasCreated) {
-            if (BuildConfig.DEBUG) {
+        if (viewModelWrapper.wasCreated) {
+            // detect that the system has killed the app - saved instance is not null, but the model was recreated
+            if (BuildConfig.DEBUG && savedInstanceState != null) {
                 Log.d("model", "Fragment recreated by system - restoring viewmodel");
             }
-            mViewModel.restoreState(savedInstanceState);
+            mViewModel.onCreate(arguments, savedInstanceState);
         }
     }
 
diff --git a/library/src/main/java/eu/inloop/viewmodel/base/ViewModelBaseActivity.java b/library/src/main/java/eu/inloop/viewmodel/base/ViewModelBaseActivity.java
@@ -14,7 +14,7 @@ public abstract class ViewModelBaseActivity<T extends IView, R extends AbstractV
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
-        mViewModeHelper.onCreate(savedInstanceState, getViewModelClass());
+        mViewModeHelper.onCreate(savedInstanceState, getViewModelClass(), getIntent().getExtras());
         //noinspection unchecked
         mViewModeHelper.initWithView((T) this);
     }
diff --git a/library/src/main/java/eu/inloop/viewmodel/base/ViewModelBaseFragment.java b/library/src/main/java/eu/inloop/viewmodel/base/ViewModelBaseFragment.java
@@ -9,14 +9,14 @@
 import eu.inloop.viewmodel.IView;
 import eu.inloop.viewmodel.ViewModelHelper;
 
-public abstract class ViewModelBaseFragment<T extends IView, R extends AbstractViewModel<T>> extends Fragment {
+public abstract class ViewModelBaseFragment<T extends IView, R extends AbstractViewModel<T>> extends Fragment implements IView {
 
     private final ViewModelHelper<T, R> mViewModeHelper = new ViewModelHelper<>();
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
-        mViewModeHelper.onCreate(savedInstanceState, getViewModelClass());
+        mViewModeHelper.onCreate(savedInstanceState, getViewModelClass(), getArguments());
     }
 
     public abstract Class<R> getViewModelClass();
@@ -62,4 +62,5 @@ public void onDestroy() {
     public R getViewModel() {
        return mViewModeHelper.getViewModel();
     }
+
 }
diff --git a/sample/src/main/java/eu/inloop/viewmodel/sample/fragment/EmptyFragment.java b/sample/src/main/java/eu/inloop/viewmodel/sample/fragment/EmptyFragment.java
diff --git a/sample/src/main/java/eu/inloop/viewmodel/sample/fragment/SampleBundleFragment.java b/sample/src/main/java/eu/inloop/viewmodel/sample/fragment/SampleBundleFragment.java
@@ -0,0 +1,36 @@
+package eu.inloop.viewmodel.sample.fragment;
+
+import android.os.Bundle;
+import android.support.annotation.Nullable;
+import android.support.v4.app.Fragment;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+
+import eu.inloop.viewmodel.IView;
+import eu.inloop.viewmodel.base.ViewModelBaseFragment;
+import eu.inloop.viewmodel.sample.R;
+import eu.inloop.viewmodel.sample.viewmodel.SampleArgumentViewModel;
+
+
+public class SampleBundleFragment extends ViewModelBaseFragment<IView, SampleArgumentViewModel> {
+
+    public static SampleBundleFragment newInstance(int userId) {
+        final Bundle bundle = new Bundle();
+        bundle.putInt(SampleArgumentViewModel.ARG_INT_USER_ID, userId);
+
+        final SampleBundleFragment fragment = new SampleBundleFragment();
+        fragment.setArguments(bundle);
+        return fragment;
+    }
+
+    @Override
+    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
+        return inflater.inflate(R.layout.fragment_empty, container, false);
+    }
+
+    @Override
+    public Class<SampleArgumentViewModel> getViewModelClass() {
+        return SampleArgumentViewModel.class;
+    }
+}
diff --git a/sample/src/main/java/eu/inloop/viewmodel/sample/fragment/UserListFragment.java b/sample/src/main/java/eu/inloop/viewmodel/sample/fragment/UserListFragment.java
@@ -55,7 +55,7 @@ public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container,
         headerView.findViewById(R.id.button1).setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View view) {
-                getFragmentManager().beginTransaction().replace(R.id.root_content, new EmptyFragment(), "empty-fragment").addToBackStack(null).commit();
+                getFragmentManager().beginTransaction().replace(R.id.root_content, SampleBundleFragment.newInstance(1234), "empty-fragment").addToBackStack(null).commit();
             }
         });
         headerView.findViewById(R.id.button2).setOnClickListener(new View.OnClickListener() {
@@ -93,7 +93,7 @@ public void showUsers(List<String> users) {
     @Override
     public void showLoading(float progress) {
         mProgressView.setVisibility(View.VISIBLE);
-        mProgressText.setText((int)(progress * 100) + "%");
+        mProgressText.setText((int) (progress * 100) + "%");
     }
 
     @Override
diff --git a/sample/src/main/java/eu/inloop/viewmodel/sample/viewmodel/SampleArgumentViewModel.java b/sample/src/main/java/eu/inloop/viewmodel/sample/viewmodel/SampleArgumentViewModel.java
@@ -0,0 +1,23 @@
+package eu.inloop.viewmodel.sample.viewmodel;
+
+import android.os.Bundle;
+import android.support.annotation.Nullable;
+import android.util.Log;
+
+import eu.inloop.viewmodel.AbstractViewModel;
+import eu.inloop.viewmodel.IView;
+
+public class SampleArgumentViewModel extends AbstractViewModel<IView> {
+
+    public static final String ARG_INT_USER_ID = "ARG_INT_USER_ID";
+
+    @Override
+    public void onCreate(@Nullable Bundle arguments, @Nullable Bundle savedInstanceState) {
+        super.onCreate(arguments, savedInstanceState);
+
+        Log.d("SampleArgumentViewModel", "ViewModel created with argument - " + arguments.getInt(ARG_INT_USER_ID));
+        if (savedInstanceState != null) {
+            Log.d("SampleArgumentViewModel", "Application killed by system, viewmodel is restored");
+        }
+    }
+}
diff --git a/sample/src/main/java/eu/inloop/viewmodel/sample/viewmodel/UserListViewModel.java b/sample/src/main/java/eu/inloop/viewmodel/sample/viewmodel/UserListViewModel.java
@@ -3,6 +3,7 @@
 import android.os.AsyncTask;
 import android.os.Bundle;
 import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -18,9 +19,18 @@ public class UserListViewModel extends AbstractViewModel<IUserListView> {
     //Don't persist state variables
     private boolean mLoadingUsers;
 
-    private int mNumberOfRunningDeletes = 0;
     private float mCurrentLoadingProgress = 0;
 
+    @Override
+    public void onCreate(@Nullable Bundle arguments, @Nullable Bundle savedInstanceState) {
+        super.onCreate(arguments, savedInstanceState);
+
+        //this will be only not null in case the application was killed due to low memory
+        if (savedInstanceState != null) {
+            mLoadedUsers = savedInstanceState.getStringArrayList("userlist");
+        }
+    }
+
     @Override
     public void initWithView(@NonNull IUserListView view) {
         super.initWithView(view);
@@ -90,7 +100,7 @@ public void deleteUser(final int position) {
         if (getView() != null) {
             getView().showUsers(mLoadedUsers);
         }
-        mNumberOfRunningDeletes++;
+
         final String itemToDelete = mLoadedUsers.get(position);
         new AsyncTask<Void, Void, Void>() {
 
@@ -102,7 +112,6 @@ protected Void doInBackground(Void... voids) {
                    //
                 }
                 mLoadedUsers.remove(itemToDelete);
-                mNumberOfRunningDeletes--;
                 return null;
             }
 
@@ -117,12 +126,6 @@ protected void onPostExecute(Void aVoid) {
     }
 
 
-    @Override
-    public void restoreState(Bundle bundle) {
-        super.restoreState(bundle);
-        mLoadedUsers = bundle.getStringArrayList("userlist");
-    }
-
     @Override
     public void saveState(Bundle bundle) {
         super.saveState(bundle);

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public abstract class ViewModelBaseActivity<T extends IView, R extends AbstractV`
`14`	`14`	`@Override`
`15`	`15`	`protected void onCreate(Bundle savedInstanceState) {`
`16`	`16`	`super.onCreate(savedInstanceState);`
`17`		`- mViewModeHelper.onCreate(savedInstanceState, getViewModelClass());`
	`17`	`+ mViewModeHelper.onCreate(savedInstanceState, getViewModelClass(), getIntent().getExtras());`
`18`	`18`	`//noinspection unchecked`
`19`	`19`	`mViewModeHelper.initWithView((T) this);`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,14 +9,14 @@`
`9`	`9`	`import eu.inloop.viewmodel.IView;`
`10`	`10`	`import eu.inloop.viewmodel.ViewModelHelper;`
`11`	`11`
`12`		`-public abstract class ViewModelBaseFragment<T extends IView, R extends AbstractViewModel<T>> extends Fragment {`
	`12`	`+public abstract class ViewModelBaseFragment<T extends IView, R extends AbstractViewModel<T>> extends Fragment implements IView {`
`13`	`13`
`14`	`14`	`private final ViewModelHelper<T, R> mViewModeHelper = new ViewModelHelper<>();`
`15`	`15`
`16`	`16`	`@Override`
`17`	`17`	`public void onCreate(Bundle savedInstanceState) {`
`18`	`18`	`super.onCreate(savedInstanceState);`
`19`		`- mViewModeHelper.onCreate(savedInstanceState, getViewModelClass());`
	`19`	`+ mViewModeHelper.onCreate(savedInstanceState, getViewModelClass(), getArguments());`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`public abstract Class<R> getViewModelClass();`
`@@ -62,4 +62,5 @@ public void onDestroy() {`
`62`	`62`	`public R getViewModel() {`
`63`	`63`	`return mViewModeHelper.getViewModel();`
`64`	`64`	`}`
	`65`	`+`
`65`	`66`	`}`