Merge pull request #69 from dinooliva/serialize

Changes serialize() to take an OutputStream as a parameter.

Author: dinooliva

core/java/com/google/instrumentation/stats/StatsContext.java

@@ -13,7 +13,8 @@
 
 package com.google.instrumentation.stats;
 
-import java.nio.ByteBuffer;
+import java.io.IOException;
+import java.io.OutputStream;
 
 /**
  * An immutable context for stats operations.
@@ -51,12 +52,12 @@ public final StatsContext with(
   /**
    * Serializes the {@link StatsContext} into the on-the-wire representation.
    *
-   * <p>The inverse of {@link StatsContextFactory#deserialize(ByteBuffer)} and should be based on
-   * the {@link StatsContext} protobuf representation.
+   * <p>The inverse of {@link StatsContextFactory#deserialize(java.io.InputStream)} and should be
+   * based on the {@link StatsContext} protobuf representation.
    *
-   * @return serialized bytes.
+   * @param output the {@link OutputStream} to add the serialized form of this {@link StatsContext}.
    */
-  public abstract ByteBuffer serialize();
+  public abstract void serialize(OutputStream output) throws IOException;
 
   /**
    * Builder for {@link StatsContext}.

core/java/com/google/instrumentation/stats/StatsContextFactory.java

@@ -13,8 +13,8 @@
 
 package com.google.instrumentation.stats;
 
-import java.nio.ByteBuffer;
-import javax.annotation.Nullable;
+import java.io.InputStream;
+import java.io.IOException;
 
 /**
  * Factory class for {@link StatsContext}.
@@ -23,14 +23,13 @@ public abstract class StatsContextFactory {
   /**
    * Creates a {@link StatsContext} from the given on-the-wire encoded representation.
    *
-   * <p>Should be the inverse of {@link StatsContext#serialize()}. The serialized representation
-   * should be based on the {@link StatsContext} protobuf representation.
+   * <p>Should be the inverse of {@link StatsContext#serialize(java.io.OutputStream)}. The
+   * serialized representation should be based on the {@link StatsContext} protobuf representation.
    *
-   * @param buffer on-the-wire representation of a {@link StatsContext}
-   * @return a {@link StatsContext} deserialized from {@code buffer}
+   * @param input on-the-wire representation of a {@link StatsContext}
+   * @return a {@link StatsContext} deserialized from {@code input}
    */
-  @Nullable
-  public abstract StatsContext deserialize(ByteBuffer buffer);
+  public abstract StatsContext deserialize(InputStream input) throws IOException;
 
   /**
    * Returns the default {@link StatsContext}.

core/java/com/google/instrumentation/stats/StatsManager.java

@@ -19,10 +19,10 @@
  */
 public abstract class StatsManager {
   /**
-   * Pull model for stats. Registers a {@link View} that will collect data to be accessed via
-   * {@link #getView(ViewDescriptor)}.
+   * Pull model for stats. Registers a {@link ViewDescriptor} that will collect data to be accessed
+   * via {@link #getView(ViewDescriptor)}.
    */
-  public abstract void registerView(ViewDescriptor view);
+  public abstract void registerView(ViewDescriptor viewDescriptor);
 
   /**
    * Returns the current stats data, {@link View}, associated with the given {@link ViewDescriptor}.

core/javatests/com/google/instrumentation/stats/StatsContextFactoryTest.java

@@ -15,7 +15,7 @@
 
 import static com.google.common.truth.Truth.assertThat;
 
-import java.nio.ByteBuffer;
+import java.io.ByteArrayInputStream;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
@@ -26,8 +26,8 @@
 @RunWith(JUnit4.class)
 public class StatsContextFactoryTest {
   @Test
-  public void testDeserializeEmpty() {
-    assertThat(Stats.getStatsContextFactory().deserialize(ByteBuffer.wrap(new byte[0])))
+  public void testDeserializeEmpty() throws Exception {
+    assertThat(Stats.getStatsContextFactory().deserialize(new ByteArrayInputStream(new byte[0])))
         .isEqualTo(Stats.getStatsContextFactory().getDefault());
   }
 }

core/javatests/com/google/instrumentation/stats/StatsContextTest.java

@@ -16,6 +16,10 @@
 import static com.google.common.truth.Truth.assertThat;
 
 import com.google.common.testing.EqualsTester;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
@@ -104,7 +108,7 @@ public void testRecordAllMeasurements() {
   }
 
   @Test
-  public void testSerialize() {
+  public void testSerialize() throws Exception {
     testSerialization(DEFAULT.builder().build());
     testSerialization(DEFAULT.with(K1, V1));
     testSerialization(DEFAULT.with(K1, V1, K2, V2, K3, V3));
@@ -137,8 +141,11 @@ public void testToString() {
     assertThat(DEFAULT.with(K1, V10).toString()).isNotEqualTo(DEFAULT.with(K1, V1).toString());
   }
 
-  private static void testSerialization(StatsContext expected) {
-    StatsContext actual = Stats.getStatsContextFactory().deserialize(expected.serialize());
+  private static void testSerialization(StatsContext expected) throws Exception {
+    ByteArrayOutputStream output = new ByteArrayOutputStream();
+    expected.serialize(output);
+    ByteArrayInputStream input = new ByteArrayInputStream(output.toByteArray());
+    StatsContext actual = Stats.getStatsContextFactory().deserialize(input);
     assertThat(actual).isEqualTo(expected);
   }
 }

core_impl/java/com/google/instrumentation/stats/StatsContextFactoryImpl.java

@@ -13,9 +13,9 @@
 
 package com.google.instrumentation.stats;
 
-import java.nio.ByteBuffer;
+import java.io.InputStream;
+import java.io.IOException;
 import java.util.HashMap;
-import javax.annotation.Nullable;
 
 /**
  * Native Implementation of {@link StatsContextFactory}.
@@ -31,9 +31,8 @@ public StatsContextFactoryImpl() {}
    * <p>The encoded tags are of the form: {@code <tag prefix> + 'key' + <tag delim> + 'value'}*
    */
   @Override
-  @Nullable
-  public StatsContextImpl deserialize(ByteBuffer buffer) {
-    return StatsSerializer.deserialize(buffer);
+  public StatsContextImpl deserialize(InputStream input) throws IOException {
+    return StatsSerializer.deserialize(input);
   }
 
   @Override

core_impl/java/com/google/instrumentation/stats/StatsContextImpl.java

@@ -13,7 +13,8 @@
 
 package com.google.instrumentation.stats;
 
-import java.nio.ByteBuffer;
+import java.io.IOException;
+import java.io.OutputStream;
 import java.util.HashMap;
 
 /**
@@ -42,8 +43,8 @@ public StatsContextImpl record(MeasurementMap stats) {
    * <p>The encoded tags are of the form: {@code <tag prefix> + 'key' + <tag delim> + 'value'}*
    */
   @Override
-  public ByteBuffer serialize() {
-    return StatsSerializer.serialize(this);
+  public void serialize(OutputStream output) throws IOException {
+    StatsSerializer.serialize(this, output);
   }
 
   @Override

core_impl/java/com/google/instrumentation/stats/StatsSerializer.java

@@ -14,12 +14,12 @@
 package com.google.instrumentation.stats;
 
 import com.google.instrumentation.stats.proto.StatsContextProto;
-import com.google.protobuf.InvalidProtocolBufferException;
 
-import java.nio.ByteBuffer;
+import java.io.InputStream;
+import java.io.IOException;
+import java.io.OutputStream;
 import java.util.HashMap;
 import java.util.Map.Entry;
-import javax.annotation.Nullable;
 
 /**
  * Native implementation {@link StatsContext} serialization.
@@ -31,7 +31,7 @@ final class StatsSerializer {
 
   // Serializes a StatsContext by transforming it into a StatsContextProto. The
   // encoded tags are of the form: (<tag prefix> + 'key' + <tag delim> + 'value')*
-  static ByteBuffer serialize(StatsContextImpl context) {
+  static void serialize(StatsContextImpl context, OutputStream output) throws IOException {
     StringBuilder builder = new StringBuilder();
     for (Entry<String, String> tag : context.tags.entrySet()) {
       builder
@@ -40,23 +40,14 @@ static ByteBuffer serialize(StatsContextImpl context) {
           .append(TAG_DELIM)
           .append(tag.getValue());
     }
-    return ByteBuffer.wrap(StatsContextProto.StatsContext
-        .newBuilder().setTags(builder.toString()).build().toByteArray());
+    StatsContextProto.StatsContext.newBuilder().setTags(builder.toString()).build().writeTo(output);
   }
 
   // Deserializes based on an serialized StatsContextProto. The encoded tags are of the form:
   // (<tag prefix> + 'key' + <tag delim> + 'value')*
-  @Nullable
-  static StatsContextImpl deserialize(ByteBuffer buffer) {
-    try {
-      StatsContextProto.StatsContext context =
-          StatsContextProto.StatsContext.parser().parseFrom(buffer.array());
-      return new StatsContextImpl(tagsFromString(context.getTags()));
-    } catch (IllegalArgumentException e) {
-      return null;
-    } catch (InvalidProtocolBufferException e) {
-      return null;
-    }
+  static StatsContextImpl deserialize(InputStream input) throws IOException {
+    StatsContextProto.StatsContext context = StatsContextProto.StatsContext.parseFrom(input);
+    return new StatsContextImpl(tagsFromString(context.getTags()));
   }
 
   private static HashMap<String, String> tagsFromString(String encoded) {