refractoring (#4541)

4D17Y4 · web-flow · commit dfabaf8b42c0 · 2021-08-10T21:29:33.000+09:00
diff --git a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListFragment.java
@@ -265,6 +265,9 @@ private void setListeners() {
         });
     }
 
+    /**
+     * Launch Custom Selector.
+     */
     @OnClick(R.id.fab_custom_gallery)
     void launchCustomSelector(){
         controller.initiateCustomGalleryPickWithPermission(getActivity());
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/helper/ImageHelper.kt b/app/src/main/java/fr/free/nrw/commons/customselector/helper/ImageHelper.kt
@@ -6,7 +6,6 @@ import fr.free.nrw.commons.customselector.model.Image
 /**
  * Image Helper object, includes all the static functions required by custom selector.
  */
-
 object ImageHelper {
 
     /**
@@ -65,10 +64,7 @@ object ImageHelper {
      */
     fun getIndexList(list: ArrayList<Image>, masterList: ArrayList<Image>): ArrayList<Int> {
 
-        /**
-         * TODO
-         * Can be optimised as masterList is sorted by time.
-         */
+         // Can be optimised as masterList is sorted by time.
 
         val indexes = arrayListOf<Int>()
         for(image in list) {
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/listeners/FolderClickListener.kt b/app/src/main/java/fr/free/nrw/commons/customselector/listeners/FolderClickListener.kt
@@ -1,5 +1,15 @@
 package fr.free.nrw.commons.customselector.listeners
 
+/**
+ * Custom Selector Folder Click Listener
+ */
 interface FolderClickListener {
+
+    /**
+     * onFolderClick
+     * @param folderId : folder id of the folder.
+     * @param folderName : folder name of the folder.
+     * @param lastItemId : last scroll position in the folder.
+     */
     fun onFolderClick(folderId: Long, folderName: String, lastItemId: Long)
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageLoaderListener.kt b/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageLoaderListener.kt
@@ -2,7 +2,21 @@ package fr.free.nrw.commons.customselector.listeners
 
 import fr.free.nrw.commons.customselector.model.Image
 
+/**
+ * Custom Selector Image Loader Listener
+ * responds to the device image query.
+ */
 interface ImageLoaderListener {
+
+    /**
+     * On image loaded
+     * @param images : queried device images.
+     */
     fun onImageLoaded(images: ArrayList<Image>)
+
+    /**
+     * On failed
+     * @param throwable : throwable exception on failure.
+     */
     fun onFailed(throwable: Throwable)
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageSelectListener.kt b/app/src/main/java/fr/free/nrw/commons/customselector/listeners/ImageSelectListener.kt
@@ -2,6 +2,14 @@ package fr.free.nrw.commons.customselector.listeners
 
 import fr.free.nrw.commons.customselector.model.Image
 
+/**
+ * Custom selector Image select listener
+ */
 interface ImageSelectListener {
+
+    /**
+     * onSelectedImagesChanged
+     * @param selectedImages : new selected images.
+     */
     fun onSelectedImagesChanged(selectedImages: ArrayList<Image>)
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/CallbackStatus.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/CallbackStatus.kt
@@ -1,5 +1,9 @@
 package fr.free.nrw.commons.customselector.model
 
+/**
+ * sealed class Callback Status.
+ * Current status of the device image query.
+ */
 sealed class CallbackStatus {
     /**
     IDLE : The callback is idle , doing nothing.
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/Folder.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/Folder.kt
@@ -1,5 +1,8 @@
 package fr.free.nrw.commons.customselector.model
 
+/**
+ * Custom selector data class Folder.
+ */
 data class Folder(
     /**
     bucketId : Unique directory id, eg 540528482
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/Image.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/Image.kt
@@ -4,6 +4,9 @@ import android.net.Uri
 import android.os.Parcel
 import android.os.Parcelable
 
+/**
+ * Custom selector data class Image.
+ */
 data class Image(
     /**
     id : Unique image id, primary key of image in device, eg 104950
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/model/Result.kt b/app/src/main/java/fr/free/nrw/commons/customselector/model/Result.kt
@@ -1,5 +1,8 @@
 package fr.free.nrw.commons.customselector.model
 
+/**
+ * Custom selector data class Result.
+ */
 data class Result(
     /**
      * CallbackStatus : stores the result status
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapter.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/FolderAdapter.kt
@@ -13,7 +13,10 @@ import fr.free.nrw.commons.customselector.listeners.FolderClickListener
 import fr.free.nrw.commons.customselector.model.Folder
 import fr.free.nrw.commons.customselector.model.Image
 
-class   FolderAdapter(
+/**
+ * Custom selector FolderAdapter.
+ */
+class FolderAdapter(
     /**
      * Application context.
      */
@@ -91,7 +94,6 @@ class   FolderAdapter(
         diffResult.dispatchUpdatesTo(this)
     }
 
-
     /**
      * returns item count.
      */
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapter.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/adapter/ImageAdapter.kt
@@ -16,6 +16,9 @@ import fr.free.nrw.commons.customselector.listeners.ImageSelectListener
 import fr.free.nrw.commons.customselector.model.Image
 import fr.free.nrw.commons.customselector.ui.selector.ImageLoader
 
+/**
+ * Custom selector ImageAdapter.
+ */
 class ImageAdapter(
     /**
      * Application Context.
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivity.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorActivity.kt
@@ -16,6 +16,9 @@ import fr.free.nrw.commons.theme.BaseActivity
 import java.io.File
 import javax.inject.Inject
 
+/**
+ * Custom Selector Activity.
+ */
 class CustomSelectorActivity: BaseActivity(), FolderClickListener, ImageSelectListener {
 
     /**
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModel.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/CustomSelectorViewModel.kt
@@ -11,6 +11,9 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.cancel
 
+/**
+ * Custom Selector view model.
+ */
 class CustomSelectorViewModel(var context: Context,var imageFileLoader: ImageFileLoader) : ViewModel() {
 
     /**
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/FolderFragment.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/FolderFragment.kt
@@ -22,6 +22,9 @@ import fr.free.nrw.commons.upload.FileProcessor
 import kotlinx.android.synthetic.main.fragment_custom_selector.view.*
 import javax.inject.Inject
 
+/**
+ * Custom selector folder fragment.
+ */
 class FolderFragment : CommonsDaggerSupportFragment() {
 
     /**
diff --git a/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoader.kt b/app/src/main/java/fr/free/nrw/commons/customselector/ui/selector/ImageFileLoader.kt
@@ -9,6 +9,10 @@ import kotlinx.coroutines.*
 import java.io.File
 import kotlin.coroutines.CoroutineContext
 
+/**
+ * Custom Selector Image File Loader.
+ * Loads device images.
+ */
 class ImageFileLoader(val context: Context) : CoroutineScope{
 
     /**
@@ -39,7 +43,7 @@ class ImageFileLoader(val context: Context) : CoroutineScope{
 
 
     /**
-     * Load the device images using cursor
+     * Load Device images using cursor
      */
     private fun getImages(listener:ImageLoaderListener) {
         val cursor = context.contentResolver.query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, projection, null, null, MediaStore.Images.Media.DATE_ADDED + " DESC")
@@ -99,7 +103,7 @@ class ImageFileLoader(val context: Context) : CoroutineScope{
         //todo Abort loading images.
     }
 
-    /**
+    /*
      *
      * TODO
      * Sha1 for image (original image).
diff --git a/app/src/main/java/fr/free/nrw/commons/data/DBOpenHelper.java b/app/src/main/java/fr/free/nrw/commons/data/DBOpenHelper.java
@@ -13,7 +13,7 @@
 public class DBOpenHelper  extends SQLiteOpenHelper {
 
     private static final String DATABASE_NAME = "commons.db";
-    private static final int DATABASE_VERSION = 14;
+    private static final int DATABASE_VERSION = 16;
     public static final String CONTRIBUTIONS_TABLE = "contributions";
     private final String DROP_TABLE_STATEMENT="DROP TABLE IF EXISTS %s";
 
diff --git a/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java b/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java
@@ -68,6 +68,11 @@ public CommonsApplicationModule(Context applicationContext) {
         this.applicationContext = applicationContext;
     }
 
+    /**
+     * Provides ImageFileLoader used to fetch device images.
+     * @param context
+     * @return
+     */
     @Provides
     public ImageFileLoader providesImageFileLoader(Context context) {
         return new ImageFileLoader(context);
diff --git a/app/src/main/java/fr/free/nrw/commons/filepicker/FilePicker.java b/app/src/main/java/fr/free/nrw/commons/filepicker/FilePicker.java
@@ -53,6 +53,12 @@ private static Intent createGalleryIntent(@NonNull Context context, int type) {
                 .putExtra(Intent.EXTRA_ALLOW_MULTIPLE, configuration(context).allowsMultiplePickingInGallery());
     }
 
+    /**
+     * CreateCustomSectorIntent, creates intent for custom selector activity.
+     * @param context
+     * @param type
+     * @return Custom selector intent
+     */
     private static Intent createCustomSelectorIntent(@NonNull Context context, int type) {
         storeType(context, type);
         return new Intent(context, CustomSelectorActivity.class);
@@ -215,6 +221,10 @@ private static void onPictureReturnedFromDocuments(Intent data, Activity activit
         }
     }
 
+    /**
+     * onPictureReturnedFromCustomSelector.
+     * Retrieve and forward the images to upload wizard through callback.
+     */
     private static void onPictureReturnedFromCustomSelector(Intent data, Activity activity, @NonNull FilePicker.Callbacks callbacks) {
         try {
             List<UploadableFile> files = getFilesFromCustomSelector(data, activity);
@@ -225,6 +235,10 @@ private static void onPictureReturnedFromCustomSelector(Intent data, Activity ac
         }
     }
 
+    /**
+     * Get files from custom selector
+     * Retrieve and process the selected images from the custom selector.
+     */
     private static List<UploadableFile> getFilesFromCustomSelector(Intent data, Activity activity) throws  IOException, SecurityException {
         List<UploadableFile> files = new ArrayList<>();
         ArrayList<Image> images = data.getParcelableArrayListExtra("Images");
diff --git a/app/src/main/java/fr/free/nrw/commons/filepicker/PickedFiles.java b/app/src/main/java/fr/free/nrw/commons/filepicker/PickedFiles.java
diff --git a/app/src/main/java/fr/free/nrw/commons/upload/UploadItem.java b/app/src/main/java/fr/free/nrw/commons/upload/UploadItem.java

Original file line number	Diff line number	Diff line change
`@@ -265,6 +265,9 @@ private void setListeners() {`
`265`	`265`	`});`
`266`	`266`	`}`
`267`	`267`
	`268`	`+ /**`
	`269`	`+ * Launch Custom Selector.`
	`270`	`+ */`
`268`	`271`	`@OnClick(R.id.fab_custom_gallery)`
`269`	`272`	`void launchCustomSelector(){`
`270`	`273`	`controller.initiateCustomGalleryPickWithPermission(getActivity());`