Merge pull request #20 from dinooliva/census-statics

Removes unnecessary static methods from class Census.

Author: sebright2

core/java/com/google/census/Census.java

@@ -13,42 +13,20 @@
 
 package com.google.census;
 
-import java.nio.ByteBuffer;
-
-import javax.annotation.Nullable;
-
 /**
  * {@link Census}.
  */
 public final class Census {
   private static final CensusContextFactory CONTEXT_FACTORY = new Provider<CensusContextFactory>(
       "com.google.census.CensusContextFactoryImpl").newInstance();
 
-  private static final CensusContext DEFAULT = CONTEXT_FACTORY.getCurrent();
-
   /** Returns the default {@link CensusContextFactory}. */
   public static CensusContextFactory getCensusContextFactory() {
     return CONTEXT_FACTORY;
   }
 
-  /** Returns the default {@link CensusContext}. */
-  public static CensusContext getDefault() {
-    return DEFAULT;
-  }
-
-  /** Returns the current thread-local {@link CensusContext}. */
-  public static CensusContext getCurrent() {
-    return CONTEXT_FACTORY.getCurrent();
-  }
-
-  /**
-   * Creates a {@link CensusContext} from the given on-the-wire encoded representation.
-   *
-   * <p>Should be the inverse of {@link CensusContext#serialize()}. The serialized representation
-   * should be based on the {@link CensusContext} protobuf representation.
-   */
-  @Nullable
-  public static CensusContext deserialize(ByteBuffer buffer) {
-    return CONTEXT_FACTORY.deserialize(buffer);
+  // VisibleForTesting
+  Census() {
+    throw new AssertionError();
   }
 }

core/java/com/google/census/CensusScope.java

@@ -41,7 +41,7 @@ public final class CensusScope implements Closeable {
    * current. Restores the saved {@link CensusContext} on close.
    */
   public CensusScope(CensusContext context) {
-    saved = Census.getCurrent();
+    saved = Census.getCensusContextFactory().getCurrent();
     context.setCurrent();
   }
 
@@ -74,7 +74,8 @@ public static CensusScope of(
 
   /** Builder for {@link CensusScope}. */
   public static final class Builder {
-    private final CensusContext.Builder builder = Census.getCurrent().builder();
+    private final CensusContext.Builder builder =
+        Census.getCensusContextFactory().getCurrent().builder();
 
     public Builder set(TagKey key, TagValue value) {
       builder.set(key, value);

core/javatests/com/google/census/CensusContextFactoryTest.java

@@ -27,11 +27,13 @@
 public class CensusContextFactoryTest {
   @Test
   public void testDeserializeEmpty() {
-    assertThat(Census.deserialize(ByteBuffer.wrap(new byte[0]))).isEqualTo(Census.getDefault());
+    assertThat(Census.getCensusContextFactory().deserialize(ByteBuffer.wrap(new byte[0])))
+        .isEqualTo(Census.getCensusContextFactory().getDefault());
   }
 
   @Test
   public void testGetCurrent() {
-    assertThat(Census.getCurrent()).isEqualTo(Census.getDefault());
+    assertThat(Census.getCensusContextFactory().getCurrent())
+        .isEqualTo(Census.getCensusContextFactory().getDefault());
   }
 }

core/javatests/com/google/census/CensusContextTest.java

@@ -28,7 +28,7 @@
  */
 @RunWith(JUnit4.class)
 public class CensusContextTest {
-  private static final CensusContext DEFAULT = Census.getDefault();
+  private static final CensusContext DEFAULT = Census.getCensusContextFactory().getDefault();
 
   private static final MetricName[] CensusMetricNames = {
     RpcConstants.RPC_CLIENT_REQUEST_BYTES, RpcConstants.RPC_CLIENT_RESPONSE_BYTES,
@@ -118,27 +118,28 @@ public void testSerialize() {
 
   @Test
   public void testSetCurrent() {
-    assertThat(DEFAULT).isEqualTo(Census.getCurrent());
+    assertThat(DEFAULT).isEqualTo(Census.getCensusContextFactory().getCurrent());
 
     CensusContext context = DEFAULT.with(K1, V1);
     context.setCurrent();
-    assertThat(context).isEqualTo(Census.getCurrent());
+    assertThat(context).isEqualTo(Census.getCensusContextFactory().getCurrent());
 
     DEFAULT.setCurrent();
-    assertThat(DEFAULT).isEqualTo(Census.getCurrent());
+    assertThat(DEFAULT).isEqualTo(Census.getCensusContextFactory().getCurrent());
   }
 
   @Test
   public void testMultipleThreadsWithContext() throws Exception {
-    CensusContext currentContext = Census.getCurrent();
-    CensusContext c1 = Census.getDefault().with(K1, V1);
-    CensusContext c2 = Census.getDefault().with(K2, V2);
+    CensusContext currentContext = Census.getCensusContextFactory().getCurrent();
+    CensusContext c1 = Census.getCensusContextFactory().getDefault().with(K1, V1);
+    CensusContext c2 = Census.getCensusContextFactory().getDefault().with(K2, V2);
     ExecutorService executor = Executors.newFixedThreadPool(1);
     // Attach c1 to the executor thread.
-    Future<?> future = executor.submit(withContext(Census.getDefault(), c1));
+    Future<?> future =
+        executor.submit(withContext(Census.getCensusContextFactory().getDefault(), c1));
     future.get();
     // Verify that the context for the current thread was not updated.
-    assertThat(Census.getCurrent()).isEqualTo(currentContext);
+    assertThat(Census.getCensusContextFactory().getCurrent()).isEqualTo(currentContext);
     // Attach c2 to the executor thread.
     future = executor.submit(withContext(c1, c2));
     future.get();
@@ -169,17 +170,17 @@ public void testToString() {
   }
 
   private static void testSerialization(CensusContext expected) {
-    CensusContext actual = Census.deserialize(expected.serialize());
+    CensusContext actual = Census.getCensusContextFactory().deserialize(expected.serialize());
     assertThat(actual).isEqualTo(expected);
   }
 
   private static final Runnable withContext(final CensusContext prev, final CensusContext next) {
     return new Runnable() {
       @Override
       public void run() {
-        assertThat(Census.getCurrent()).isEqualTo(prev);
+        assertThat(Census.getCensusContextFactory().getCurrent()).isEqualTo(prev);
         next.setCurrent();
-        assertThat(Census.getCurrent()).isEqualTo(next);
+        assertThat(Census.getCensusContextFactory().getCurrent()).isEqualTo(next);
       }
     };
   }

core/javatests/com/google/census/CensusScopeTest.java

@@ -36,83 +36,95 @@ public class CensusScopeTest {
 
   @Test
   public void testNoScope() {
-    assertEquals(Census.getCurrent(), Census.getDefault());
+    assertEquals(
+        Census.getCensusContextFactory().getCurrent(),
+        Census.getCensusContextFactory().getDefault());
   }
 
   @Test
   public void testScope() {
-    CensusScope scope = new CensusScope(Census.getCurrent().with(K1, V1));
+    CensusScope scope = new CensusScope(Census.getCensusContextFactory().getCurrent().with(K1, V1));
     try {
       assertEquals(
-          Census.getDefault().with(K1, V1),
-          Census.getCurrent());
+          Census.getCensusContextFactory().getDefault().with(K1, V1),
+          Census.getCensusContextFactory().getCurrent());
     } finally {
       scope.close();
     }
-    assertEquals(Census.getDefault(), Census.getCurrent());
+    assertEquals(
+        Census.getCensusContextFactory().getDefault(),
+        Census.getCensusContextFactory().getCurrent());
   }
 
   @Test
   public void testNestedScope() {
-    CensusScope s1 = new CensusScope(Census.getCurrent().with(K1, V1));
+    CensusScope s1 = new CensusScope(Census.getCensusContextFactory().getCurrent().with(K1, V1));
     try {
       assertEquals(
-          Census.getDefault().with(K1, V1),
-          Census.getCurrent());
-      CensusScope s2 = new CensusScope(Census.getCurrent().with(K2, V2));
+          Census.getCensusContextFactory().getDefault().with(K1, V1),
+          Census.getCensusContextFactory().getCurrent());
+      CensusScope s2 = new CensusScope(Census.getCensusContextFactory().getCurrent().with(K2, V2));
       try {
         assertEquals(
-            Census.getDefault().with(K1, V1).with(K2, V2),
-            Census.getCurrent());
+            Census.getCensusContextFactory().getDefault().with(K1, V1).with(K2, V2),
+            Census.getCensusContextFactory().getCurrent());
       } finally {
         s2.close();
       }
       assertEquals(
-          Census.getDefault().with(K1, V1),
-          Census.getCurrent());
+          Census.getCensusContextFactory().getDefault().with(K1, V1),
+          Census.getCensusContextFactory().getCurrent());
     } finally {
       s1.close();
     }
-    assertEquals(Census.getDefault(), Census.getCurrent());
+    assertEquals(
+        Census.getCensusContextFactory().getDefault(),
+        Census.getCensusContextFactory().getCurrent());
   }
 
   @Test
   public void testOf1() {
     CensusScope scope = CensusScope.of(K1, V1);
     try {
       assertEquals(
-          Census.getDefault().with(K1, V1),
-          Census.getCurrent());
+          Census.getCensusContextFactory().getDefault().with(K1, V1),
+          Census.getCensusContextFactory().getCurrent());
     } finally {
       scope.close();
     }
-    assertEquals(Census.getDefault(), Census.getCurrent());
+    assertEquals(
+        Census.getCensusContextFactory().getDefault(),
+        Census.getCensusContextFactory().getCurrent());
   }
 
   @Test
   public void testOf2() {
     CensusScope scope = CensusScope.of(K1, V1, K2, V2);
     try {
       assertEquals(
-          Census.getDefault().with(K1, V1, K2, V2),
-          Census.getCurrent());
+          Census.getCensusContextFactory().getDefault().with(K1, V1, K2, V2),
+          Census.getCensusContextFactory().getCurrent());
     } finally {
       scope.close();
     }
-    assertEquals(Census.getDefault(), Census.getCurrent());
+    assertEquals(
+        Census.getCensusContextFactory().getDefault(),
+        Census.getCensusContextFactory().getCurrent());
   }
 
   @Test
   public void testOf3() {
     CensusScope scope = CensusScope.of(K1, V1, K2, V2, K3, V3);
     try {
       assertEquals(
-          Census.getDefault().with(K1, V1, K2, V2, K3, V3),
-          Census.getCurrent());
+          Census.getCensusContextFactory().getDefault().with(K1, V1, K2, V2, K3, V3),
+          Census.getCensusContextFactory().getCurrent());
     } finally {
       scope.close();
     }
-    assertEquals(Census.getDefault(), Census.getCurrent());
+    assertEquals(
+        Census.getCensusContextFactory().getDefault(),
+        Census.getCensusContextFactory().getCurrent());
   }
 
   @Test
@@ -122,11 +134,12 @@ public void testBuilder() {
     CensusScope scope = builder.build();
     try {
       assertEquals(
-          Census.getDefault().builder().set(K1, V1).set(K2, V2).set(K3, V3).set(K4, V4).build(),
-          Census.getCurrent());
+          Census.getCensusContextFactory().getDefault()
+          .builder().set(K1, V1).set(K2, V2).set(K3, V3).set(K4, V4).build(),
+          Census.getCensusContextFactory().getCurrent());
     } finally {
       scope.close();
     }
-    assertEquals(Census.getDefault(), Census.getCurrent());
+    assertEquals(Census.getCensusContextFactory().getDefault(), Census.getCensusContextFactory().getCurrent());
   }
 }

core/javatests/com/google/census/CensusTest.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2016, Google Inc.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.census;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/**
+ * Tests for {@link RpcConstants}
+ */
+@RunWith(JUnit4.class)
+public final class CensusTest {
+  @Test
+  public void getCensusContextFactory() {
+    assertThat(Census.getCensusContextFactory()).isNotNull();
+  }
+
+  @Test(expected = AssertionError.class)
+  public void testConstructor() {
+    new Census();
+  }
+}

examples/java/com/google/census/CensusRunner.java

@@ -37,27 +37,30 @@ public class CensusRunner {
 
   public static void main(String args[]) {
     System.out.println("Hello Census World");
-    System.out.println("Default Tags: " + Census.getDefault());
-    System.out.println("Current Tags: " + Census.getCurrent());
+    System.out.println("Default Tags: " + Census.getCensusContextFactory().getDefault());
+    System.out.println("Current Tags: " + Census.getCensusContextFactory().getCurrent());
     CensusScope scope1 = CensusScope.of(K1, V1, K2, V2);
     try {
-        CensusContext context1 = Census.getDefault().with(K1, V1, K2, V2);
-        System.out.println("  Current Tags: " + Census.getCurrent());
-        System.out.println("  Current == Default + tags1: " + Census.getCurrent().equals(context1));
+        CensusContext context1 = Census.getCensusContextFactory().getDefault().with(K1, V1, K2, V2);
+        System.out.println("  Current Tags: " + Census.getCensusContextFactory().getCurrent());
+        System.out.println("  Current == Default + tags1: "
+            + Census.getCensusContextFactory().getCurrent().equals(context1));
         CensusScope scope2 = CensusScope.of(K3, V3, K4, V4);
         try {
             CensusContext context2 = context1.with(K3, V3, K4, V4);
-            System.out.println("    Current Tags: " + Census.getCurrent());
+            System.out.println("    Current Tags: "
+                + Census.getCensusContextFactory().getCurrent());
             System.out.println("    Current == Default + tags1 + tags2: "
-                + Census.getCurrent().equals(context2));
-            Census.getCurrent().record(MetricMap.of(M1, 0.2, M2, 0.4));
+                + Census.getCensusContextFactory().getCurrent().equals(context2));
+            Census.getCensusContextFactory().getCurrent().record(MetricMap.of(M1, 0.2, M2, 0.4));
         } finally {
           scope2.close();
         }
     } finally {
       scope1.close();
     }
     System.out.println("Current == Default: " +
-        Census.getCurrent().equals(Census.getDefault()));
+        Census.getCensusContextFactory().getCurrent()
+        .equals(Census.getCensusContextFactory().getDefault()));
   }
 }