Issue 6289 - Fix OnSharedPreferenceChangeListener

adblockplussbrowser/src/main/java/org/adblockplus/sbrowser/contentblocker/util/SharedPrefsUtils.java

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 package org.adblockplus.sbrowser.contentblocker.util;
 
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.preference.PreferenceManager;
 
 import java.util.Set;
 
-import static android.content.SharedPreferences.*;

[diegocarloslima, 2018/01/19 14:26:11]

We usually try to avoid the wildcard import

[jens, 2018/01/19 14:36:07]

Acknowledged.

-
 public class SharedPrefsUtils
 {
 
   public static void putBoolean(Context context, int keyResId, boolean value)
   {
-    final Editor editor = getDefaultSharedPreferences(context).edit();
+    final SharedPreferences.Editor editor = getDefaultSharedPreferences(context).edit();
     editor.putBoolean(context.getString(keyResId), value).apply();
   }
 
   public static boolean getBoolean(Context context, int keyResId, boolean defValue)
   {
     final SharedPreferences preferences = getDefaultSharedPreferences(context);
     try
     {
       return preferences.getBoolean(context.getString(keyResId), defValue);
     }
     catch (ClassCastException e)
     {
       return defValue;
     }
   }
 
   public static void putInt(Context context, int keyResId, int value)
   {
-    final Editor editor = getDefaultSharedPreferences(context).edit();
+    final SharedPreferences.Editor editor = getDefaultSharedPreferences(context).edit();
     editor.putInt(context.getString(keyResId), value).apply();
   }
 
   public static int getInt(Context context, int keyResId, int defValue)
   {
     final SharedPreferences preferences = getDefaultSharedPreferences(context);
     try
     {
       return preferences.getInt(context.getString(keyResId), defValue);
     }
     catch (ClassCastException e)
     {
       return defValue;
     }
   }
 
   public static void putString(Context context, int keyResId, String value)
   {
-    final Editor editor = getDefaultSharedPreferences(context).edit();
+    final SharedPreferences.Editor editor = getDefaultSharedPreferences(context).edit();
     editor.putString(context.getString(keyResId), value).apply();
   }
 
   public static String getString(Context context, int keyResId, String defValue)
   {
     final SharedPreferences preferences = getDefaultSharedPreferences(context);
     try
     {
       return preferences.getString(context.getString(keyResId), defValue);
     }
     catch (ClassCastException e)
     {
       return defValue;
     }
   }
 
   public static void putStringSet(Context context, int keyResId, Set<String> values)
   {
-    final Editor editor = getDefaultSharedPreferences(context).edit();
+    final SharedPreferences.Editor editor = getDefaultSharedPreferences(context).edit();
     editor.putStringSet(context.getString(keyResId), values).apply();
   }
 
   public static Set<String> getStringSet(Context context, int keyResId, Set<String> defValues)
   {
     final SharedPreferences preferences = getDefaultSharedPreferences(context);
     try
     {
       return preferences.getStringSet(context.getString(keyResId), defValues);
     }
@@ skipping 13 matching lines @@
       OnSharedPreferenceChangeListener listener)
   {
     getDefaultSharedPreferences(context).unregisterOnSharedPreferenceChangeListener(listener);
   }
 
   private static SharedPreferences getDefaultSharedPreferences(Context context)
   {
     return PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());
   }
 
   public abstract static class OnSharedPreferenceChangeListener

[anton, 2018/01/22 05:41:13]

are you sure that it's better to use class hierarchy with just 1 method body
definition instead of just interface? i think interface is preferred in this
case.

[diegocarloslima, 2018/01/22 11:09:26]

With an interface, we cannot make onSharedPreferenceChanged(SharedPreferences
sharedPreferences, String key) final. The whole goal for this abstract class is
to hide the SharedPreferences instance through the callback. We want to hide the
SharedPreferences, to better indicate that the SharePreferences should be
modified by using the SharedPrefsUtils methods

       implements SharedPreferences.OnSharedPreferenceChangeListener
   {
 
     @Override
     public final void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)
     {
       this.onSharedPreferenceChanged(key);
     }
 
     protected abstract void onSharedPreferenceChanged(String key);
   }
 }