Merge pull request #41 from zeoflow/listeners-name

Added `I` before interface name

demo/proguard-rules.pro

@@ -20,4 +20,4 @@
 # hide the original source file value.
 #-renamesourcefileattribute SourceFile
 
--keep public class * implements com.zeoflow.memo.annotation.MemoStorageImpl { *; }
+-keep public class * implements com.zeoflow.memo.annotation.IMemoStorageImpl { *; }

memo-annotation/src/main/java/com/zeoflow/memo/annotation/MemoChangedListener.java → memo-annotation/src/main/java/com/zeoflow/memo/annotation/IMemoChangedListener.java

@@ -17,11 +17,11 @@
 package com.zeoflow.memo.annotation;
 
 /**
- * MemoChangedListener is an interface of the listening for
+ * IMemoChangedListener is an interface of the listening for
  *
  * <p>SharedPreference persistence's value changes.
  */
-public interface MemoChangedListener
+public interface IMemoChangedListener
 {
 
 }

memo-annotation/src/main/java/com/zeoflow/memo/annotation/MemoStorageImpl.java → memo-annotation/src/main/java/com/zeoflow/memo/annotation/IMemoStorageImpl.java

@@ -16,7 +16,7 @@
 
 package com.zeoflow.memo.annotation;
 
-public interface MemoStorageImpl
+public interface IMemoStorageImpl
 {
 
 }

memo-compiler/src/main/java/com/zeoflow/memo/processor/InjectorGenerator.java

@@ -26,7 +26,7 @@
 import com.zeoflow.jx.file.TypeSpec;
 import com.zeoflow.memo.annotation.Encoder;
 import com.zeoflow.memo.annotation.InjectPreference;
-import com.zeoflow.memo.annotation.MemoStorageImpl;
+import com.zeoflow.memo.annotation.IMemoStorageImpl;
 
 import javax.lang.model.element.PackageElement;
 import javax.lang.model.element.TypeElement;
@@ -64,9 +64,9 @@ public TypeSpec generate()
     {
         return TypeSpec.classBuilder(getClazzName())
                 .addJavadoc("Injector Class for $T\n", TypeName.get(injectedElement.asType()))
-                .addJavadoc("Generated by Storage (https://github.com/zeoflow/storage).\n")
+                .addJavadoc("Generated by IStorage (https://github.com/zeoflow/storage).\n")
                 .addModifiers(PUBLIC)
-                .addSuperinterface(MemoStorageImpl.class)
+                .addSuperinterface(IMemoStorageImpl.class)
                 .superclass(TypeName.get(injectedElement.asType()))
                 .addMethod(getConstructorSpec())
                 .build();

memo-compiler/src/main/java/com/zeoflow/memo/processor/PreferenceChangeListenerGenerator.java

@@ -24,7 +24,7 @@
 import com.zeoflow.jx.file.ParameterSpec;
 import com.zeoflow.jx.file.ParameterizedTypeName;
 import com.zeoflow.jx.file.TypeSpec;
-import com.zeoflow.memo.annotation.MemoChangedListener;
+import com.zeoflow.memo.annotation.IMemoChangedListener;
 
 import java.util.List;
 
@@ -54,7 +54,7 @@ public TypeSpec generateInterface()
         TypeSpec.Builder builder =
                 TypeSpec.interfaceBuilder(getClazzName())
                         .addModifiers(PUBLIC)
-                        .addSuperinterface(MemoChangedListener.class)
+                        .addSuperinterface(IMemoChangedListener.class)
                         .addMethod(getOnChangedSpec());
         return builder.build();
     }

memo-compiler/src/main/java/com/zeoflow/memo/processor/PreferenceComponentGenerator.java

@@ -66,7 +66,7 @@ public PreferenceComponentGenerator(
     public TypeSpec generate()
     {
         return TypeSpec.classBuilder(getClazzName())
-                .addJavadoc("Generated by Storage (https://github.com/zeoflow/storage).\n")
+                .addJavadoc("Generated by IStorage (https://github.com/zeoflow/storage).\n")
                 .addModifiers(PUBLIC)
                 .addSuperinterface(annotatedClazz.typeName)
                 .addField(getInstanceFieldSpec())

memo-compiler/src/main/java/com/zeoflow/memo/processor/PreferenceEntityGenerator.java

@@ -72,7 +72,7 @@ public TypeSpec generate()
         TypeSpec.Builder builder =
                 TypeSpec.classBuilder(getClazzName())
                         .addJavadoc("Preference class for $T\n", ClassName.get(annotatedClazz.annotatedElement))
-                        .addJavadoc("Generated by Storage (https://github.com/zeoflow/storage).\n")
+                        .addJavadoc("Generated by IStorage (https://github.com/zeoflow/storage).\n")
                         .addModifiers(PUBLIC)
                         .superclass(ClassName.get(annotatedClazz.annotatedElement))
                         .addFields(getFieldSpecs());

memo/src/main/java/com/zeoflow/memo/DefaultMemoFacade.java

@@ -1,13 +1,13 @@
 package com.zeoflow.memo;
 
-public class DefaultMemoFacade implements MemoFacade
+public class DefaultMemoFacade implements IMemoFacade
 {
 
-    private final Storage storage;
-    private final Converter converter;
+    private final IStorage storage;
+    private final IConverter converter;
     private final Encryption encryption;
-    private final Serializer serializer;
-    private final LogInterceptor logInterceptor;
+    private final ISerializer serializer;
+    private final ILogInterceptor logInterceptor;
 
     public DefaultMemoFacade(MemoBuilder builder)
     {
@@ -39,7 +39,7 @@ public <T> boolean put(String key, T value)
         log("Memo.put -> Converted to " + plainText);
         if (plainText == null)
         {
-            log("Memo.put -> Converter failed");
+            log("Memo.put -> IConverter failed");
             return false;
         }
 
@@ -132,7 +132,7 @@ public <T> T get(String key)
             log("Memo.get -> Converted to : " + result);
         } catch (Exception e)
         {
-            log("Memo.get -> Converter failed");
+            log("Memo.get -> IConverter failed");
         }
 
         return result;
@@ -155,7 +155,7 @@ public <T> String encrypt(T value)
         log("Memo.put -> Converted to " + plainText);
         if (plainText == null)
         {
-            log("Memo.put -> Converter failed");
+            log("Memo.put -> IConverter failed");
             return "";
         }
 
@@ -223,7 +223,7 @@ public <T> T decrypt(String value)
             log("Memo.get -> Converted to : " + result);
         } catch (Exception e)
         {
-            log("Memo.get -> Converter failed");
+            log("Memo.get -> IConverter failed");
         }
 
         return result;

memo/src/main/java/com/zeoflow/memo/Converter.java → memo/src/main/java/com/zeoflow/memo/IConverter.java

@@ -6,7 +6,7 @@
  *
  * @see MemoConverter
  */
-public interface Converter
+public interface IConverter
 {
 
     /**

memo/src/main/java/com/zeoflow/memo/LogInterceptor.java → memo/src/main/java/com/zeoflow/memo/ILogInterceptor.java

@@ -3,7 +3,7 @@
 /**
  * Interceptor for all logs happens in the library
  */
-public interface LogInterceptor
+public interface ILogInterceptor
 {
 
     /**

memo/src/main/java/com/zeoflow/memo/MemoFacade.java → memo/src/main/java/com/zeoflow/memo/IMemoFacade.java

@@ -1,6 +1,6 @@
 package com.zeoflow.memo;
 
-public interface MemoFacade
+public interface IMemoFacade
 {
 
     <T> boolean put(String key, T value);
@@ -25,7 +25,7 @@ public interface MemoFacade
 
     void destroy();
 
-    class EmptyMemoFacade implements MemoFacade
+    class EmptyMemoFacade implements IMemoFacade
     {
 
         @Override

memo/src/main/java/com/zeoflow/memo/Parser.java → memo/src/main/java/com/zeoflow/memo/IParser.java

@@ -4,14 +4,14 @@
 
 /**
  * Intermediate layer that handles serialization/deserialization for the end result.
- * This is not the same as {@link Serializer}. This interface is only used to convert the intermediate value
- * into String or vice-versa to be used for {@link Storage}
+ * This is not the same as {@link ISerializer}. This interface is only used to convert the intermediate value
+ * into String or vice-versa to be used for {@link IStorage}
  *
  * <p>Use custom implementation if built-in implementation is not enough.</p>
  *
  * @see ZsonParser
  */
-public interface Parser
+public interface IParser
 {
 
     /**

memo/src/main/java/com/zeoflow/memo/Serializer.java → memo/src/main/java/com/zeoflow/memo/ISerializer.java

@@ -7,7 +7,7 @@
  *
  * @see MemoSerializer
  */
-public interface Serializer
+public interface ISerializer
 {
 
     /**

memo/src/main/java/com/zeoflow/memo/Storage.java → memo/src/main/java/com/zeoflow/memo/IStorage.java

@@ -7,7 +7,7 @@
  *
  * @see SharedPreferencesStorage
  */
-public interface Storage
+public interface IStorage
 {
 
     /**

memo/src/main/java/com/zeoflow/memo/Memo.java

@@ -10,7 +10,7 @@
 public final class Memo
 {
 
-    static MemoFacade memoFacade = new MemoFacade.EmptyMemoFacade();
+    static IMemoFacade memoFacade = new IMemoFacade.EmptyMemoFacade();
 
     private Memo()
     {

memo/src/main/java/com/zeoflow/memo/MemoBuilder.java

@@ -17,12 +17,12 @@ public class MemoBuilder
     private static final String STORAGE_TAG_DO_NOT_CHANGE = "MemoStorage";
 
     private final Context context;
-    private Storage cryptoStorage;
-    private Converter converter;
-    private Parser parser;
+    private IStorage cryptoStorage;
+    private IConverter converter;
+    private IParser parser;
     private Encryption encryption;
-    private Serializer serializer;
-    private LogInterceptor logInterceptor;
+    private ISerializer serializer;
+    private ILogInterceptor logInterceptor;
 
     public MemoBuilder()
     {
@@ -34,7 +34,7 @@ public MemoBuilder(Context context)
 
         this.context = context.getApplicationContext();
     }
-    LogInterceptor getLogInterceptor()
+    ILogInterceptor getLogInterceptor()
     {
         if (logInterceptor == null)
         {
@@ -45,46 +45,46 @@ LogInterceptor getLogInterceptor()
         }
         return logInterceptor;
     }
-    public MemoBuilder setLogInterceptor(LogInterceptor logInterceptor)
+    public MemoBuilder setLogInterceptor(ILogInterceptor logInterceptor)
     {
         this.logInterceptor = logInterceptor;
         return this;
     }
-    Storage getStorage()
+    IStorage getStorage()
     {
         if (cryptoStorage == null)
         {
             cryptoStorage = new SharedPreferencesStorage(context, STORAGE_TAG_DO_NOT_CHANGE);
         }
         return cryptoStorage;
     }
-    public MemoBuilder setStorage(Storage storage)
+    public MemoBuilder setStorage(IStorage storage)
     {
         this.cryptoStorage = storage;
         return this;
     }
-    Converter getConverter()
+    IConverter getConverter()
     {
         if (converter == null)
         {
             converter = new MemoConverter(getParser());
         }
         return converter;
     }
-    public MemoBuilder setConverter(Converter converter)
+    public MemoBuilder setConverter(IConverter converter)
     {
         this.converter = converter;
         return this;
     }
-    Parser getParser()
+    IParser getParser()
     {
         if (parser == null)
         {
             parser = new ZsonParser(new Zson());
         }
         return parser;
     }
-    public MemoBuilder setParser(Parser parser)
+    public MemoBuilder setParser(IParser parser)
     {
         this.parser = parser;
         return this;
@@ -106,15 +106,15 @@ public MemoBuilder setEncryption(Encryption encryption)
         this.encryption = encryption;
         return this;
     }
-    Serializer getSerializer()
+    ISerializer getSerializer()
     {
         if (serializer == null)
         {
             serializer = new MemoSerializer(getLogInterceptor());
         }
         return serializer;
     }
-    public MemoBuilder setSerializer(Serializer serializer)
+    public MemoBuilder setSerializer(ISerializer serializer)
     {
         this.serializer = serializer;
         return this;

memo/src/main/java/com/zeoflow/memo/MemoConverter.java

@@ -15,16 +15,16 @@
  * Serializable types will be encoded/decoded object stream
  * Not serializable objects will be encoded/decoded by parser
  */
-final class MemoConverter implements Converter
+final class MemoConverter implements IConverter
 {
 
-    private final Parser parser;
+    private final IParser parser;
 
-    public MemoConverter(Parser parser)
+    public MemoConverter(IParser parser)
     {
         if (parser == null)
         {
-            throw new NullPointerException("Parser should not be null");
+            throw new NullPointerException("IParser should not be null");
         }
         this.parser = parser;
     }

memo/src/main/java/com/zeoflow/memo/MemoSerializer.java

@@ -5,16 +5,16 @@
 import java.util.Map;
 import java.util.Set;
 
-class MemoSerializer implements Serializer
+class MemoSerializer implements ISerializer
 {
 
     private static final char DELIMITER = '@';
     private static final String INFO_DELIMITER = "#";
     private static final char NEW_VERSION = 'V';
 
-    private final LogInterceptor logInterceptor;
+    private final ILogInterceptor logInterceptor;
 
-    MemoSerializer(LogInterceptor logInterceptor)
+    MemoSerializer(ILogInterceptor logInterceptor)
     {
         this.logInterceptor = logInterceptor;
     }

memo/src/main/java/com/zeoflow/memo/SharedPreferencesStorage.java

@@ -3,7 +3,7 @@
 import android.content.Context;
 import android.content.SharedPreferences;
 
-final class SharedPreferencesStorage implements Storage
+final class SharedPreferencesStorage implements IStorage
 {
 
     private final SharedPreferences preferences;

memo/src/main/java/com/zeoflow/memo/ZsonParser.java

@@ -7,7 +7,7 @@
 
 import java.lang.reflect.Type;
 
-public final class ZsonParser implements Parser
+public final class ZsonParser implements IParser
 {
 
     private final Zson zson;