Added Javadoc and other minor improvements

Pratham2305 · Pratham2305 · commit 67c56ead63c0 · 2021-06-02T18:08:38.000+05:30
diff --git a/app/src/main/java/fr/free/nrw/commons/bookmarks/BookmarkListRootFragment.java b/app/src/main/java/fr/free/nrw/commons/bookmarks/BookmarkListRootFragment.java
@@ -169,6 +169,11 @@ public Integer getContributionStateAt(int position) {
     return null;
   }
 
+  /**
+   * Reload media detail fragment once media is nominated
+   *
+   * @param index item position that has been nominated
+   */
   @Override
   public void refreshNominatedMedia(int index) {
     if(mediaDetails != null && !listFragment.isVisible()) {
diff --git a/app/src/main/java/fr/free/nrw/commons/category/CategoryDetailsActivity.java b/app/src/main/java/fr/free/nrw/commons/category/CategoryDetailsActivity.java
@@ -165,6 +165,11 @@ public Integer getContributionStateAt(int position) {
         return null;
     }
 
+    /**
+     * Reload media detail fragment once media is nominated
+     *
+     * @param index item position that has been nominated
+     */
     @Override
     public void refreshNominatedMedia(int index) {
         if (getSupportFragmentManager().getBackStackEntryCount() == 1) {
diff --git a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsFragment.java b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsFragment.java
@@ -565,6 +565,9 @@ public void pauseUpload(Contribution contribution) {
         contributionsPresenter.saveContribution(contribution);
     }
 
+    /**
+     * Notify the viewpager that number of items have changed.
+     */
     @Override
     public void viewPagerNotifyDataSetChanged() {
         if (mediaDetailPagerFragment != null) {
@@ -627,6 +630,11 @@ public MediaDetailPagerFragment getMediaDetailPagerFragment() {
         return mediaDetailPagerFragment;
     }
 
+    /**
+     * Reload media detail fragment once media is nominated
+     *
+     * @param index item position that has been nominated
+     */
     @Override
     public void refreshNominatedMedia(int index) {
         if(mediaDetailPagerFragment != null && !contributionsListFragment.isVisible()) {
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
@@ -158,6 +158,10 @@ public void onItemRangeInserted(int positionStart, int itemCount) {
         }
       }
 
+      /**
+       * Called whenever items in the list have changed
+       * Calls viewPagerNotifyDataSetChanged() that will notify the viewpager
+       */
       @Override
       public void onItemRangeChanged(final int positionStart, final int itemCount) {
         super.onItemRangeChanged(positionStart, itemCount);
@@ -419,6 +423,7 @@ public interface Callback {
 
     void pauseUpload(Contribution contribution);
 
+    // Notify the viewpager that number of items have changed.
     void viewPagerNotifyDataSetChanged();
   }
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/explore/ExploreListRootFragment.java b/app/src/main/java/fr/free/nrw/commons/explore/ExploreListRootFragment.java
@@ -153,6 +153,11 @@ public Integer getContributionStateAt(int position) {
     return null;
   }
 
+  /**
+   * Reload media detail fragment once media is nominated
+   *
+   * @param index item position that has been nominated
+   */
   @Override
   public void refreshNominatedMedia(int index) {
     if(mediaDetails != null && !listFragment.isVisible()) {
diff --git a/app/src/main/java/fr/free/nrw/commons/explore/SearchActivity.java b/app/src/main/java/fr/free/nrw/commons/explore/SearchActivity.java
@@ -183,6 +183,11 @@ public Integer getContributionStateAt(int position) {
         return null;
     }
 
+    /**
+     * Reload media detail fragment once media is nominated
+     *
+     * @param index item position that has been nominated
+     */
     @Override
     public void refreshNominatedMedia(int index) {
         if (getSupportFragmentManager().getBackStackEntryCount() == 1) {
diff --git a/app/src/main/java/fr/free/nrw/commons/explore/depictions/WikidataItemDetailsActivity.java b/app/src/main/java/fr/free/nrw/commons/explore/depictions/WikidataItemDetailsActivity.java
@@ -191,6 +191,11 @@ public Integer getContributionStateAt(int position) {
         return null;
     }
 
+    /**
+     * Reload media detail fragment once media is nominated
+     *
+     * @param index item position that has been nominated
+     */
     @Override
     public void refreshNominatedMedia(int index) {
         if (getSupportFragmentManager().getBackStackEntryCount() == 1) {
diff --git a/app/src/main/java/fr/free/nrw/commons/explore/media/PageableMediaFragment.kt b/app/src/main/java/fr/free/nrw/commons/explore/media/PageableMediaFragment.kt
@@ -56,6 +56,11 @@ abstract class PageableMediaFragment : BasePagingFragment<Media>(), MediaDetailP
 
     override fun getContributionStateAt(position: Int) = null
 
+    /**
+     * Reload media detail fragment once media is nominated
+     *
+     * @param index item position that has been nominated
+     */
     override fun refreshNominatedMedia(index: Int) {
         activity?.onBackPressed()
         categoryImagesCallback.onMediaClicked(index)
diff --git a/app/src/main/java/fr/free/nrw/commons/media/MediaDetailFragment.java b/app/src/main/java/fr/free/nrw/commons/media/MediaDetailFragment.java
@@ -231,6 +231,8 @@ public static MediaDetailFragment forMedia(int index, boolean editable, boolean
      */
     private int minimumHeightOfMetadata = 200;
 
+    final static String NOMINATING_MEDIA = "Nominating %s";
+
     @Override
     public void onSaveInstanceState(Bundle outState) {
         super.onSaveInstanceState(outState);
@@ -352,7 +354,7 @@ public void onResume() {
 
         media = detailProvider.getMediaAtPosition(index);
 
-        if(media != null && applicationKvStore.getBoolean("Nominating " + media.getDisplayTitle(), false)) {
+        if(media != null && applicationKvStore.getBoolean(String.format(NOMINATING_MEDIA, media.getImageUrl()), false)) {
             enableProgressBar();
         }
 
@@ -450,8 +452,8 @@ private void onDiscussionLoaded(String discussion) {
 
     private void onDeletionPageExists(Boolean deletionPageExists) {
         if (deletionPageExists){
-            if(applicationKvStore.getBoolean("Nominating " + media.getDisplayTitle(), false)) {
-                applicationKvStore.remove("Nominating " + media.getDisplayTitle());
+            if(applicationKvStore.getBoolean(String.format(NOMINATING_MEDIA, media.getImageUrl()), false)) {
+                applicationKvStore.remove(String.format(NOMINATING_MEDIA, media.getImageUrl()));
                 progressBarDeletion.setVisibility(GONE);
             }
             delete.setVisibility(GONE);
@@ -854,7 +856,7 @@ public void onTextChanged(CharSequence s, int start, int before, int count) {
 
     @SuppressLint("CheckResult")
     private void onDeleteClicked(Spinner spinner) {
-        applicationKvStore.putBoolean("Nominating " + media.getDisplayTitle(), true);
+        applicationKvStore.putBoolean(String.format(NOMINATING_MEDIA, media.getImageUrl()), true);
         enableProgressBar();
         String reason = spinner.getSelectedItem().toString();
         Single<Boolean> resultSingle = reasonBuilder.getReason(media, reason)
@@ -863,25 +865,25 @@ private void onDeleteClicked(Spinner spinner) {
             .subscribeOn(Schedulers.io())
             .observeOn(AndroidSchedulers.mainThread())
             .subscribe(s -> {
-                if(applicationKvStore.getBoolean("Nominating " + media.getDisplayTitle(), false)) {
-                    applicationKvStore.remove("Nominating " + media.getDisplayTitle());
+                if(applicationKvStore.getBoolean(String.format(NOMINATING_MEDIA, media.getImageUrl()), false)) {
+                    applicationKvStore.remove(String.format(NOMINATING_MEDIA, media.getImageUrl()));
                     callback.nominatingForDeletion(index);
                 }
             });
     }
 
     @SuppressLint("CheckResult")
     private void onDeleteClickeddialogtext(String reason) {
-        applicationKvStore.putBoolean("Nominating " + media.getDisplayTitle(), true);
+        applicationKvStore.putBoolean(String.format(NOMINATING_MEDIA, media.getImageUrl()), true);
         enableProgressBar();
         Single<Boolean> resultSingletext = reasonBuilder.getReason(media, reason)
                 .flatMap(reasonString -> deleteHelper.makeDeletion(getContext(), media, reason));
         resultSingletext
             .subscribeOn(Schedulers.io())
             .observeOn(AndroidSchedulers.mainThread())
             .subscribe(s -> {
-                if(applicationKvStore.getBoolean("Nominating " + media.getDisplayTitle(), false)) {
-                    applicationKvStore.remove("Nominating " + media.getDisplayTitle());
+                if(applicationKvStore.getBoolean(String.format(NOMINATING_MEDIA, media.getImageUrl()), false)) {
+                    applicationKvStore.remove(String.format(NOMINATING_MEDIA, media.getImageUrl()));
                     callback.nominatingForDeletion(index);
                 }
             });
@@ -894,6 +896,9 @@ public void onSeeMoreClicked(){
         }
     }
 
+    /**
+     * Enable Progress Bar and Update delete button text.
+     */
     private void enableProgressBar() {
         progressBarDeletion.setVisibility(VISIBLE);
         delete.setText("Nominating for Deletion");
diff --git a/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java b/app/src/main/java/fr/free/nrw/commons/media/MediaDetailPagerFragment.java
@@ -382,6 +382,11 @@ public void onDataSetChanged() {
         }
     }
 
+    /**
+     * Called after the media is nominated for deletion
+     *
+     * @param index item position that has been nominated
+     */
     @Override
     public void nominatingForDeletion(int index) {
       provider.refreshNominatedMedia(index);
@@ -404,6 +409,7 @@ public interface MediaDetailProvider {
 
         Integer getContributionStateAt(int position);
 
+        // Reload media detail fragment once media is nominated
         void refreshNominatedMedia(int index);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -158,6 +158,10 @@ public void onItemRangeInserted(int positionStart, int itemCount) {`
`158`	`158`	`}`
`159`	`159`	`}`
`160`	`160`
	`161`	`+ /**`
	`162`	`+ * Called whenever items in the list have changed`
	`163`	`+ * Calls viewPagerNotifyDataSetChanged() that will notify the viewpager`
	`164`	`+ */`
`161`	`165`	`@Override`
`162`	`166`	`public void onItemRangeChanged(final int positionStart, final int itemCount) {`
`163`	`167`	`super.onItemRangeChanged(positionStart, itemCount);`
`@@ -419,6 +423,7 @@ public interface Callback {`
`419`	`423`
`420`	`424`	`void pauseUpload(Contribution contribution);`
`421`	`425`
	`426`	`+ // Notify the viewpager that number of items have changed.`
`422`	`427`	`void viewPagerNotifyDataSetChanged();`
`423`	`428`	`}`
`424`	`429`	`}`
Original file line number	Diff line number	Diff line change
`@@ -382,6 +382,11 @@ public void onDataSetChanged() {`
`382`	`382`	`}`
`383`	`383`	`}`
`384`	`384`
	`385`	`+ /**`
	`386`	`+ * Called after the media is nominated for deletion`
	`387`	`+ *`
	`388`	`+ * @param index item position that has been nominated`
	`389`	`+ */`
`385`	`390`	`@Override`
`386`	`391`	`public void nominatingForDeletion(int index) {`
`387`	`392`	`provider.refreshNominatedMedia(index);`
`@@ -404,6 +409,7 @@ public interface MediaDetailProvider {`
`404`	`409`
`405`	`410`	`Integer getContributionStateAt(int position);`
`406`	`411`
	`412`	`+ // Reload media detail fragment once media is nominated`
`407`	`413`	`void refreshNominatedMedia(int index);`
`408`	`414`	`}`
`409`	`415`