1 files changed, 60 insertions, 30 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java
index fceeb52713..b1a05ec436 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java
@@ -10,43 +10,73 @@ import com.mapbox.mapboxsdk.maps.MapView;
  * @see Marker
  */
 public class Icon {
-    private Bitmap mBitmap;
-    private String mId;
+  private Bitmap mBitmap;
+  private String mId;
 
-    Icon(String id, Bitmap bitmap) {
-        mId = id;
-        mBitmap = bitmap;
-    }
-
-    public String getId() {
-        return mId;
-    }
+  Icon(String id, Bitmap bitmap) {
+    mId = id;
+    mBitmap = bitmap;
+  }
 
-    public Bitmap getBitmap() {
-        return mBitmap;
-    }
+  /**
+   * {@link String} identifier for this {@link Icon}.
+   *
+   * @return {@link String} identifier for this {@link Icon}.
+   */
+  public String getId() {
+    return mId;
+  }
 
-    @Override
-    public boolean equals(Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
+  /**
+   * Get the {@link Bitmap} being used for this {@link Icon}.
+   *
+   * @return The {@link Bitmap} being used for the {@link Icon}.
+   */
+  public Bitmap getBitmap() {
+    return mBitmap;
+  }
 
-        Icon icon = (Icon) o;
+  /**
+   * Compares this {@link Icon} object with another {@link Icon} and determines if they match.
+   *
+   * @param object Another {@link Icon} to compare with this object.
+   * @return True if the {@link Icon} being passed in matches this {@link Icon} object. Else,
+   * false.
+   */
+  @Override
+  public boolean equals(Object object) {
+    if (this == object) {
+      return true;
+    }
+    if (object == null || getClass() != object.getClass()) {
+      return false;
+    }
 
-        if (!mBitmap.equals(icon.mBitmap)) return false;
-        return mId.equals(icon.mId);
+    Icon icon = (Icon) object;
 
+    if (!mBitmap.equals(icon.mBitmap)) {
+      return false;
     }
+    return mId.equals(icon.mId);
+  }
 
-    @Override
-    public int hashCode() {
-        int result = 0;
-        if (mBitmap != null) {
-            result = mBitmap.hashCode();
-        }
-        if (mId != null) {
-            result = 31 * result + mId.hashCode();
-        }
-        return result;
+  /**
+   * Gives an integer which can be used as the bucket number for storing elements of the set/map.
+   * This bucket number is the address of the element inside the set/map. There's no guarantee
+   * that this hash value will be consistent between different Java implementations, or even
+   * between different execution runs of the same program.
+   *
+   * @return integer value you can use for storing element.
+   */
+  @Override
+  public int hashCode() {
+    int result = 0;
+    if (mBitmap != null) {
+      result = mBitmap.hashCode();
+    }
+    if (mId != null) {
+      result = 31 * result + mId.hashCode();
     }
+    return result;
+  }
 }