cleanup / javadoc

halfhp · halfhp · commit 200aaddfea98 · 2016-05-01T11:54:33.000-05:00
diff --git a/androidplot-core/src/main/java/com/androidplot/Bounds.java b/androidplot-core/src/main/java/com/androidplot/Bounds.java
@@ -18,6 +18,7 @@
 
 /**
  * Defines simple min/max boundary.  Differs from {@link LineRegion} in that it accepts null values.
+ * @since 0.9.7
  */
 public class Bounds {
 
diff --git a/androidplot-core/src/main/java/com/androidplot/LineRegion.java b/androidplot-core/src/main/java/com/androidplot/LineRegion.java
@@ -39,6 +39,7 @@ public LineRegion(Number v1, Number v2) {
      * @param v1
      * @param v2
      * @return The distance between val1 and val2 or null if either parameters are null.
+     * @since 0.9.7
      */
     public static Number measure(Number v1, Number v2) {
         return new LineRegion(v1, v2).length();
diff --git a/androidplot-core/src/main/java/com/androidplot/Plot.java b/androidplot-core/src/main/java/com/androidplot/Plot.java
@@ -528,6 +528,7 @@ protected void notifyListenersAfterDraw(Canvas canvas) {
      * @param formatter
      * @param series
      * @return True if all series were successfully added, false otherwise.
+     * @since 0.9.7
      */
     public synchronized boolean addSeries(FormatterType formatter, SeriesType... series) {
         for(SeriesType s : series) {
@@ -572,7 +573,7 @@ public synchronized boolean addSeries(SeriesType series, FormatterType formatter
      * @return The {@link SeriesAndFormatter} that matches the series and rendererClass params, or null if one is not found.
      */
     protected SeriesAndFormatter<SeriesType, FormatterType> getSeries(SeriesType series, Class<? extends RendererType> rendererClass) {
-        for(SeriesAndFormatter<SeriesType, FormatterType> thisPair : seriesRegistry.asList()) {
+        for(SeriesAndFormatter<SeriesType, FormatterType> thisPair : seriesRegistry) {
             if(thisPair.getSeries() == series && thisPair.getFormatter().getRendererClass() == rendererClass) {
                 return thisPair;
             }
@@ -588,7 +589,7 @@ protected SeriesAndFormatter<SeriesType, FormatterType> getSeries(SeriesType ser
     protected List<SeriesAndFormatter<SeriesType, FormatterType>> getSeries(SeriesType series) {
         List<SeriesAndFormatter<SeriesType, FormatterType>> results =
                 new ArrayList<SeriesAndFormatter<SeriesType, FormatterType>>();
-        for(SeriesAndFormatter<SeriesType, FormatterType> thisPair : seriesRegistry.asList()) {
+        for(SeriesAndFormatter<SeriesType, FormatterType> thisPair : seriesRegistry) {
             if(thisPair.getSeries() == series) {
                 results.add(thisPair);
             }
diff --git a/androidplot-core/src/main/java/com/androidplot/SeriesRegistry.java b/androidplot-core/src/main/java/com/androidplot/SeriesRegistry.java
@@ -24,45 +24,17 @@
 import java.util.List;
 
 /**
- * Created by halfhp on 1/16/16.
+ * Manages a list of {@link Series} and their associated {@link Formatter} in the context of a {@link Plot}.
+ * @since 0.9.7
  */
-public class SeriesRegistry<SeriesType extends Series, FormatterType extends Formatter> {
-
-    private ArrayList<SeriesAndFormatter<SeriesType, FormatterType>> sfPairs;
-
-    {
-        sfPairs = new ArrayList<>();
-    }
-
-    public void add(SeriesAndFormatter<SeriesType, FormatterType> sfPair) {
-        sfPairs.add(sfPair);
-    }
-
-    public void remove(SeriesAndFormatter<SeriesType, FormatterType> sfPair) {
-        sfPairs.remove(sfPair);
-    }
-
-    public ArrayList<SeriesAndFormatter<SeriesType, FormatterType>> asList() {
-        return sfPairs;
-    }
-
-    public Iterator<SeriesAndFormatter<SeriesType, FormatterType>> iterator() {
-        return sfPairs.iterator();
-    }
+public class SeriesRegistry<SeriesType extends Series, FormatterType extends Formatter>
+        extends ArrayList<SeriesAndFormatter<SeriesType, FormatterType>> {
 
     public List<SeriesType> getSeriesList() {
         List<SeriesType> result = new ArrayList<>();
-        for(SeriesAndFormatter<SeriesType, FormatterType> sfPair : sfPairs) {
+        for(SeriesAndFormatter<SeriesType, FormatterType> sfPair : this) {
             result.add(sfPair.getSeries());
         }
         return result;
     }
-
-    public boolean isEmpty() {
-        return sfPairs.isEmpty();
-    }
-
-    public int size() {
-        return sfPairs.size();
-    }
 }
diff --git a/androidplot-core/src/main/java/com/androidplot/candlestick/CandlestickFormatter.java b/androidplot-core/src/main/java/com/androidplot/candlestick/CandlestickFormatter.java
@@ -26,6 +26,7 @@
 
 /**
  * Format for drawing a value using {@link CandlestickRenderer}.
+ * @since 0.9.7
  */
 public class CandlestickFormatter extends XYSeriesFormatter<XYRegionFormatter> {
 
diff --git a/androidplot-core/src/main/java/com/androidplot/candlestick/CandlestickMaker.java b/androidplot-core/src/main/java/com/androidplot/candlestick/CandlestickMaker.java
@@ -21,6 +21,7 @@
 
 /**
  * Helper utility to simplify the creation of of candlestick charts
+ * @since 0.9.7
  */
 public abstract class CandlestickMaker {
 
diff --git a/androidplot-core/src/main/java/com/androidplot/candlestick/CandlestickRenderer.java b/androidplot-core/src/main/java/com/androidplot/candlestick/CandlestickRenderer.java
@@ -20,7 +20,7 @@
 import com.androidplot.ui.RenderStack;
 import com.androidplot.ui.SeriesAndFormatter;
 import com.androidplot.util.ValPixConverter;
-import com.androidplot.xy.ComplexRenderer;
+import com.androidplot.xy.GroupRenderer;
 import com.androidplot.xy.XYPlot;
 import com.androidplot.xy.XYSeries;
 
@@ -37,8 +37,9 @@
  * high, low, open, close
  *
  * {@link CandlestickMaker} simplified methods for setting up a candlestick chart.
+ * @since 0.9.7
  */
-public class CandlestickRenderer<FormatterType extends CandlestickFormatter> extends ComplexRenderer<FormatterType> {
+public class CandlestickRenderer<FormatterType extends CandlestickFormatter> extends GroupRenderer<FormatterType> {
 
     private static final int HIGH_INDEX = 0;
     private static final int LOW_INDEX = 1;
diff --git a/androidplot-core/src/main/java/com/androidplot/ui/RenderStack.java b/androidplot-core/src/main/java/com/androidplot/ui/RenderStack.java
@@ -84,7 +84,7 @@ public void sync() {
          * TODO: rendering performance *might* be improved by reusing StackElement instances but I'm skeptical...
          */
         getElements().clear();
-        List<SeriesAndFormatter<SeriesType, FormatterType>> pairList = plot.getSeriesRegistry().asList();
+        List<SeriesAndFormatter<SeriesType, FormatterType>> pairList = plot.getSeriesRegistry();
         for(SeriesAndFormatter<SeriesType, FormatterType> thisPair: pairList) {
             getElements().add(new StackElement<>(thisPair));
         }
diff --git a/androidplot-core/src/main/java/com/androidplot/ui/SeriesRenderer.java b/androidplot-core/src/main/java/com/androidplot/ui/SeriesRenderer.java
@@ -96,7 +96,7 @@ public void drawSeriesLegendIcon(Canvas canvas, RectF rect, SeriesFormatterType
      */
     public List<SeriesAndFormatter<SeriesType, ? extends SeriesFormatterType>> getSeriesAndFormatterList() {
         List<SeriesAndFormatter<SeriesType, ? extends SeriesFormatterType>> results = new ArrayList<>();
-        ArrayList<SeriesAndFormatter> sfList = getPlot().getSeriesRegistry().asList();
+        ArrayList<SeriesAndFormatter> sfList = getPlot().getSeriesRegistry();
 
         for(SeriesAndFormatter<SeriesType, ? extends SeriesFormatterType> thisPair : sfList) {
             if(thisPair.rendersWith(this)) {
@@ -106,9 +106,14 @@ public void drawSeriesLegendIcon(Canvas canvas, RectF rect, SeriesFormatterType
         return results;
     }
 
+    /**
+     *
+     * @return
+     * @since 0.9.7
+     */
     public List<SeriesType> getSeriesList() {
         List<SeriesType> results = new ArrayList<>();
-        ArrayList<SeriesAndFormatter> sfList = getPlot().getSeriesRegistry().asList();
+        ArrayList<SeriesAndFormatter> sfList = getPlot().getSeriesRegistry();
 
         for(SeriesAndFormatter<SeriesType, ? extends SeriesFormatterType> thisPair : sfList) {
             if(thisPair.rendersWith(this)) {
diff --git a/androidplot-core/src/main/java/com/androidplot/xy/BarRenderer.java b/androidplot-core/src/main/java/com/androidplot/xy/BarRenderer.java
@@ -33,7 +33,7 @@
 /**
  * Renders the points in an XYSeries as bars.
  */
-public class BarRenderer<FormatterType extends BarFormatter> extends ComplexRenderer<FormatterType> {
+public class BarRenderer<FormatterType extends BarFormatter> extends GroupRenderer<FormatterType> {
 
     private BarRenderStyle renderStyle = BarRenderStyle.OVERLAID;  // default Render Style
 	private BarWidthStyle widthStyle = BarWidthStyle.FIXED_WIDTH;  // default Width Style
diff --git a/androidplot-core/src/main/java/com/androidplot/xy/GroupRenderer.java b/androidplot-core/src/main/java/com/androidplot/xy/GroupRenderer.java
@@ -28,13 +28,14 @@
 /**
  * Renders data to an XYPlot that potentially contains more than a single yVal per index.
  * Examples of such data are bar plot groups, candlestick charts, etc.
+ * @since 0.9.7
  */
-public abstract class ComplexRenderer<FormatterType extends XYSeriesFormatter<XYRegionFormatter>>
+public abstract class GroupRenderer<FormatterType extends XYSeriesFormatter<XYRegionFormatter>>
         extends XYSeriesRenderer<XYSeries, FormatterType>  {
 
-    private static final String TAG = ComplexRenderer.class.getName();
+    private static final String TAG = GroupRenderer.class.getName();
 
-    public ComplexRenderer(XYPlot plot) {
+    public GroupRenderer(XYPlot plot) {
         super(plot);
     }
 
diff --git a/androidplot-core/src/main/java/com/androidplot/xy/XYBounds.java b/androidplot-core/src/main/java/com/androidplot/xy/XYBounds.java
@@ -21,6 +21,7 @@
 /**
  * Defines a rectangle using xy min/max values.  XYBounds differs from {@link RectRegion} in that
  * it accepts null values.
+ * @since 0.9.7
  */
 public class XYBounds {
 
diff --git a/androidplot-core/src/main/java/com/androidplot/xy/XYConstraints.java b/androidplot-core/src/main/java/com/androidplot/xy/XYConstraints.java
@@ -18,6 +18,7 @@
 
 /**
  * Calculates the min/max constraints for an xy plane.
+ * @since 0.9.7
  */
 public class XYConstraints {
 
diff --git a/androidplot-core/src/main/java/com/androidplot/xy/XYLegendWidget.java b/androidplot-core/src/main/java/com/androidplot/xy/XYLegendWidget.java
@@ -171,7 +171,7 @@ protected synchronized void doOnDraw(Canvas canvas, RectF widgetRect) {
         RectF cellRect;
 
         // draw each series legend item:
-        for(SeriesAndFormatter<XYSeries, XYSeriesFormatter> sfPair : plot.getSeriesRegistry().asList()) {
+        for(SeriesAndFormatter<XYSeries, XYSeriesFormatter> sfPair : plot.getSeriesRegistry()) {
             cellRect = it.next();
             XYSeriesFormatter format = sfPair.getFormatter();
             drawSeriesLegendCell(canvas, plot.getRenderer(sfPair.getFormatter().getRendererClass()),
diff --git a/demoapp/src/main/java/com/androidplot/demos/BarPlotExampleActivity.java b/demoapp/src/main/java/com/androidplot/demos/BarPlotExampleActivity.java
@@ -312,7 +312,7 @@ private void onPlotClicked(PointF point) {
 
 
             // find the closest value to the selection:
-            for (SeriesAndFormatter<XYSeries, ? extends XYSeriesFormatter> sfPair : plot.getSeriesRegistry().asList()) {
+            for (SeriesAndFormatter<XYSeries, ? extends XYSeriesFormatter> sfPair : plot.getSeriesRegistry()) {
                 XYSeries series = sfPair.getSeries();
                 for (int i = 0; i < series.size(); i++) {
                     Number thisX = series.getX(i);

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public void sync() {`
`84`	`84`	`* TODO: rendering performance might be improved by reusing StackElement instances but I'm skeptical...`
`85`	`85`	`*/`
`86`	`86`	`getElements().clear();`
`87`		`- List<SeriesAndFormatter<SeriesType, FormatterType>> pairList = plot.getSeriesRegistry().asList();`
	`87`	`+ List<SeriesAndFormatter<SeriesType, FormatterType>> pairList = plot.getSeriesRegistry();`
`88`	`88`	`for(SeriesAndFormatter<SeriesType, FormatterType> thisPair: pairList) {`
`89`	`89`	`getElements().add(new StackElement<>(thisPair));`
`90`	`90`	`}`