Deprecate Window and WindowData. (#1018)

* Deprecate Window and WindowType in Stats APIs

* Window and WindowData will continue to be NonNull

* Suppress warnings for impl, exporter and zpages.

* NoopStats should continue to use old method.

4 files changed, 28 insertions, 20 deletions

diff --git a/contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcViewConstants.java b/contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcViewConstants.java
index b643c3dd..093d55a9 100644
--- a/contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcViewConstants.java
+++ b/contrib/grpc_metrics/src/main/java/io/opencensus/contrib/grpc/metrics/RpcViewConstants.java
@@ -49,9 +49,6 @@ import io.opencensus.stats.Aggregation.Distribution;
 import io.opencensus.stats.Aggregation.Mean;
 import io.opencensus.stats.BucketBoundaries;
 import io.opencensus.stats.View;
-import io.opencensus.stats.View.AggregationWindow;
-import io.opencensus.stats.View.AggregationWindow.Cumulative;
-import io.opencensus.stats.View.AggregationWindow.Interval;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -61,6 +58,7 @@ import java.util.List;
  *
  * @since 0.8
  */
+@SuppressWarnings("deprecation")
 public final class RpcViewConstants {
 
   // Common histogram bucket boundaries for bytes received/sets Views.
@@ -118,9 +116,16 @@ public final class RpcViewConstants {
 
   @VisibleForTesting static final Duration MINUTE = Duration.create(60, 0);
   @VisibleForTesting static final Duration HOUR = Duration.create(60 * 60, 0);
-  @VisibleForTesting static final AggregationWindow CUMULATIVE = Cumulative.create();
-  @VisibleForTesting static final AggregationWindow INTERVAL_MINUTE = Interval.create(MINUTE);
-  @VisibleForTesting static final AggregationWindow INTERVAL_HOUR = Interval.create(HOUR);
+
+  @VisibleForTesting
+  static final View.AggregationWindow CUMULATIVE = View.AggregationWindow.Cumulative.create();
+
+  @VisibleForTesting
+  static final View.AggregationWindow INTERVAL_MINUTE =
+      View.AggregationWindow.Interval.create(MINUTE);
+
+  @VisibleForTesting
+  static final View.AggregationWindow INTERVAL_HOUR = View.AggregationWindow.Interval.create(HOUR);
 
   // Rpc client cumulative views.
 
diff --git a/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/RpczZPageHandler.java b/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/RpczZPageHandler.java
index 1a2ebb82..56ccb734 100644
--- a/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/RpczZPageHandler.java
+++ b/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/RpczZPageHandler.java
@@ -88,8 +88,6 @@ import io.opencensus.stats.AggregationData.DistributionData;
 import io.opencensus.stats.AggregationData.MeanData;
 import io.opencensus.stats.View;
 import io.opencensus.stats.ViewData;
-import io.opencensus.stats.ViewData.AggregationWindowData;
-import io.opencensus.stats.ViewData.AggregationWindowData.CumulativeData;
 import io.opencensus.stats.ViewManager;
 import io.opencensus.tags.TagValue;
 import java.io.BufferedWriter;
@@ -108,6 +106,7 @@ import org.checkerframework.checker.nullness.qual.Nullable;
 */
 
 /** HTML page formatter for gRPC cumulative and interval stats. */
+@SuppressWarnings("deprecation")
 final class RpczZPageHandler extends ZPageHandler {
 
   private final ViewManager viewManager;
@@ -364,7 +363,10 @@ final class RpczZPageHandler extends ZPageHandler {
 
   // Gets RPC stats by its view definition, and set it to stats snapshot.
   private static void getStats(
-      StatsSnapshot snapshot, AggregationData data, View view, AggregationWindowData windowData) {
+      StatsSnapshot snapshot,
+      AggregationData data,
+      View view,
+      ViewData.AggregationWindowData windowData) {
     if (view == RPC_CLIENT_ROUNDTRIP_LATENCY_VIEW || view == RPC_SERVER_SERVER_LATENCY_VIEW) {
       snapshot.avgLatencyTotal = ((DistributionData) data).getMean();
     } else if (view == RPC_CLIENT_ROUNDTRIP_LATENCY_MINUTE_VIEW
@@ -387,7 +389,7 @@ final class RpczZPageHandler extends ZPageHandler {
           distributionData.getCount()
               * distributionData.getMean()
               / BYTES_PER_KB
-              / getDurationInSecs((CumulativeData) windowData);
+              / getDurationInSecs((ViewData.AggregationWindowData.CumulativeData) windowData);
     } else if (view == RPC_CLIENT_REQUEST_BYTES_MINUTE_VIEW
         || view == RPC_SERVER_REQUEST_BYTES_MINUTE_VIEW) {
       MeanData meanData = (MeanData) data;
@@ -404,7 +406,7 @@ final class RpczZPageHandler extends ZPageHandler {
           distributionData.getCount()
               * distributionData.getMean()
               / BYTES_PER_KB
-              / getDurationInSecs((CumulativeData) windowData);
+              / getDurationInSecs((ViewData.AggregationWindowData.CumulativeData) windowData);
     } else if (view == RPC_CLIENT_RESPONSE_BYTES_MINUTE_VIEW
         || view == RPC_SERVER_RESPONSE_BYTES_MINUTE_VIEW) {
       MeanData meanData = (MeanData) data;
@@ -426,12 +428,15 @@ final class RpczZPageHandler extends ZPageHandler {
     } else if (view == RPC_CLIENT_STARTED_COUNT_CUMULATIVE_VIEW
         || view == RPC_SERVER_STARTED_COUNT_CUMULATIVE_VIEW) {
       snapshot.countTotal = ((CountData) data).getCount();
-      snapshot.rpcRateTotal = snapshot.countTotal / getDurationInSecs((CumulativeData) windowData);
+      snapshot.rpcRateTotal =
+          snapshot.countTotal
+              / getDurationInSecs((ViewData.AggregationWindowData.CumulativeData) windowData);
     } // TODO(songya): compute and store latency percentiles.
   }
 
   // Calculates the duration of the given CumulativeData in seconds.
-  private static double getDurationInSecs(CumulativeData cumulativeData) {
+  private static double getDurationInSecs(
+      ViewData.AggregationWindowData.CumulativeData cumulativeData) {
     return toDoubleSeconds(cumulativeData.getEnd().subtractTimestamp(cumulativeData.getStart()));
   }
 
diff --git a/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/StatszZPageHandler.java b/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/StatszZPageHandler.java
index bcf87d57..bacdc294 100644
--- a/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/StatszZPageHandler.java
+++ b/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/StatszZPageHandler.java
@@ -41,8 +41,6 @@ import io.opencensus.stats.AggregationData.SumDataLong;
 import io.opencensus.stats.Measure;
 import io.opencensus.stats.View;
 import io.opencensus.stats.ViewData;
-import io.opencensus.stats.ViewData.AggregationWindowData;
-import io.opencensus.stats.ViewData.AggregationWindowData.CumulativeData;
 import io.opencensus.stats.ViewManager;
 import io.opencensus.tags.TagKey;
 import io.opencensus.tags.TagValue;
@@ -66,6 +64,7 @@ import org.checkerframework.checker.nullness.qual.Nullable;
 */
 
 /** HTML page formatter for all exported {@link View}s. */
+@SuppressWarnings("deprecation")
 final class StatszZPageHandler extends ZPageHandler {
 
   private static final Object monitor = new Object();
@@ -305,7 +304,7 @@ final class StatszZPageHandler extends ZPageHandler {
   }
 
   private static void emitViewInfo(
-      View view, AggregationWindowData windowData, PrintWriter out, Formatter formatter) {
+      View view, ViewData.AggregationWindowData windowData, PrintWriter out, Formatter formatter) {
     formatter.format("<table width=100%% %s>", TABLE_BORDER);
     emitViewInfoHeader(out, formatter);
 
@@ -324,9 +323,9 @@ final class StatszZPageHandler extends ZPageHandler {
                 Functions.<String>throwAssertionError());
     formatter.format("<td>%s</td>", aggregationType);
     windowData.match(
-        new Function<CumulativeData, Void>() {
+        new Function<ViewData.AggregationWindowData.CumulativeData, Void>() {
           @Override
-          public Void apply(CumulativeData arg) {
+          public Void apply(ViewData.AggregationWindowData.CumulativeData arg) {
             formatter.format("<td>%s</td>", toDate(arg.getStart()));
             formatter.format("<td>%s</td>", toDate(arg.getEnd()));
             return null;
diff --git a/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/ZPageHandlers.java b/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/ZPageHandlers.java
index fa581d11..710e9a20 100644
--- a/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/ZPageHandlers.java
+++ b/contrib/zpages/src/main/java/io/opencensus/contrib/zpages/ZPageHandlers.java
@@ -22,7 +22,6 @@ import com.sun.net.httpserver.HttpServer;
 import io.opencensus.stats.Measure;
 import io.opencensus.stats.Stats;
 import io.opencensus.stats.View;
-import io.opencensus.stats.View.AggregationWindow.Cumulative;
 import io.opencensus.trace.Tracing;
 import java.io.IOException;
 import java.net.InetSocketAddress;
@@ -128,7 +127,7 @@ public final class ZPageHandlers {
   /**
    * Returns a {@code ZPageHandler} for all registered {@link View}s and {@link Measure}s.
    *
-   * <p>Only {@link Cumulative} views are exported. {@link View}s are grouped by directories.
+   * <p>Only {@code Cumulative} views are exported. {@link View}s are grouped by directories.
    *
    * @return a {@code ZPageHandler} for all registered {@code View}s and {@code Measure}s.
    * @since 0.12.0