Add more javadocs

Author: Jawnnypoo

app/build.gradle

@@ -6,7 +6,7 @@ android {
 
     defaultConfig {
         applicationId "com.savvyapps.togglebuttonlayout.sample"
-        minSdkVersion 15
+        minSdkVersion 16
         targetSdkVersion rootProject.ext.targetSdkVersion
         versionCode 1
         versionName "1.0"

app/src/main/java/com/savvyapps/togglebuttonlayout/sample/ToggleButtonLayoutActivity.java

@@ -36,9 +36,9 @@ public void onClick(View v) {
             }
         });
 
-        toggleButtonLayout.setOnToggleSelectedListener(new ToggleButtonLayout.OnToggleSelectedListener() {
+        toggleButtonLayout.setOnToggleSelectedListener(new ToggleButtonLayout.OnToggledListener() {
             @Override
-            public void onToggleSelected(Toggle toggle, boolean selected) {
+            public void onToggled(Toggle toggle, boolean selected) {
                 Snackbar.make(root, "Toggle " + toggle.getId() + " selected state " + selected, Snackbar.LENGTH_LONG)
                         .show();
             }

togglebuttonlayout/build.gradle

@@ -5,7 +5,7 @@ android {
     buildToolsVersion rootProject.ext.buildToolsVersion
 
     defaultConfig {
-        minSdkVersion 15
+        minSdkVersion 16
         targetSdkVersion rootProject.ext.targetSdkVersion
         versionCode 1
         versionName "1.0"

togglebuttonlayout/src/main/java/com/savvyapps/togglebuttonlayout/Toggle.java

@@ -1,7 +1,7 @@
 package com.savvyapps.togglebuttonlayout;
 
 import android.graphics.drawable.Drawable;
-import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 
 /**
  * An item within a {@link ToggleButtonLayout}
@@ -13,7 +13,7 @@ public class Toggle {
     private CharSequence title;
     protected boolean selected;
 
-    public Toggle(int id, @NonNull Drawable icon, @NonNull CharSequence title) {
+    public Toggle(int id, @Nullable Drawable icon, @Nullable CharSequence title) {
         if (id == 0) {
             throw new IllegalArgumentException("Toggle must have a non-zero id");
         }
@@ -22,10 +22,18 @@ public Toggle(int id, @NonNull Drawable icon, @NonNull CharSequence title) {
         this.title = title;
     }
 
+    /**
+     * The ID provided within the Toggle
+     * @return id
+     */
     public int getId() {
         return id;
     }
 
+    /**
+     * The icon drawable inflated by the menu resource or passed during creation
+     * @return the icon
+     */
     public Drawable getIcon() {
         return icon;
     }
@@ -34,6 +42,10 @@ public CharSequence getTitle() {
         return title;
     }
 
+    /**
+     * The selection state of the toggle
+     * @return true if toggle is selected, false otherwise
+     */
     public boolean isSelected() {
         return selected;
     }

togglebuttonlayout/src/main/java/com/savvyapps/togglebuttonlayout/ToggleButtonLayout.java

@@ -38,10 +38,17 @@ public class ToggleButtonLayout extends CardView {
 
     @Retention(SOURCE)
     @IntDef({MODE_WRAP, MODE_EVEN})
-    public @interface Mode {
+    @interface Mode {
     }
 
+    /**
+     * Toggles will wrap content. Default
+     */
     public static final int MODE_WRAP = 0;
+
+    /**
+     * Toggles will be evenly distributed within view
+     */
     public static final int MODE_EVEN = 1;
 
     private LinearLayout linearLayout;
@@ -59,7 +66,7 @@ public class ToggleButtonLayout extends CardView {
     @Mode
     private int mode;
     //callbacks
-    private OnToggleSelectedListener listener;
+    private OnToggledListener listener;
 
     private OnClickListener onClickListener = new OnClickListener() {
         @Override
@@ -73,7 +80,7 @@ public void onClick(View v) {
             } else {
                 setToggled(toggle.getId(), !toggle.selected);
                 if (listener != null) {
-                    listener.onToggleSelected(toggle, toggle.selected);
+                    listener.onToggled(toggle, toggle.selected);
                 }
             }
         }
@@ -148,7 +155,7 @@ public void inflateMenu(@MenuRes int menuId) {
      *
      * @param toggle the toggle to add
      */
-    public void addToggle(Toggle toggle) {
+    public void addToggle(@NonNull Toggle toggle) {
         toggles.add(toggle);
         ToggleView toggleView = new ToggleView(getContext(), toggle, layoutRes);
         toggleView.setOnClickListener(onClickListener);
@@ -171,7 +178,7 @@ public void addToggle(Toggle toggle) {
      *
      * @param listener listener
      */
-    public void setOnToggleSelectedListener(OnToggleSelectedListener listener) {
+    public void setOnToggleSelectedListener(OnToggledListener listener) {
         this.listener = listener;
     }
 
@@ -204,6 +211,11 @@ public void reset() {
         }
     }
 
+    /**
+     * Manually set the toggled state of the specified toggle. This will not notify any {@link OnToggledListener}
+     * @param toggleId the id of the toggle
+     * @param toggled true if should be toggled on, false otherwise
+     */
     public void setToggled(int toggleId, boolean toggled) {
         for (Toggle toggle : toggles) {
             if (toggle.getId() == toggleId) {
@@ -223,6 +235,10 @@ public void setToggled(int toggleId, boolean toggled) {
         }
     }
 
+    /**
+     * Get a list of selected toggles
+     * @return the selected toggles
+     */
     @NonNull
     public List<Toggle> getSelectedToggles() {
         List<Toggle> selectedToggles = new ArrayList<>();
@@ -247,6 +263,7 @@ private void toggleState(Toggle toggle) {
     /**
      * Default view for Toggle
      */
+    @SuppressLint("ViewConstructor")
     static class ToggleView extends FrameLayout {
 
         Toggle toggle;
@@ -279,7 +296,16 @@ public ToggleView(Context context, Toggle toggle, @Nullable @LayoutRes Integer l
         }
     }
 
-    public interface OnToggleSelectedListener {
-        void onToggleSelected(Toggle toggle, boolean selected);
+    /**
+     * Listener for when a toggle is toggled
+     */
+    public interface OnToggledListener {
+
+        /**
+         * The toggle has been toggled
+         * @param toggle the toggle
+         * @param selected true if selected, false if unselected
+         */
+        void onToggled(Toggle toggle, boolean selected);
     }
 }