Annotate SafeArg/UnsafeArg name parameter with @CompileTimeConstant (#…

…105) This adds a dependency on error_prone_annotations to safe-logging, previously only required by safe-logging preconditions.
palantir · Jan 17, 2019 · 0ba6bae · 0ba6bae
1 parent 21e0713
commit 0ba6bae
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/preconditions/build.gradle b/preconditions/build.gradle
@@ -2,7 +2,6 @@ apply from: "${rootDir}/gradle/publish-jar.gradle"
 
 dependencies {
     api project(':safe-logging')
-    api 'com.google.errorprone:error_prone_annotations:2.1.3'
     compileOnly 'com.google.code.findbugs:jsr305'
 
     testImplementation 'junit:junit'

diff --git a/safe-logging/build.gradle b/safe-logging/build.gradle
@@ -1 +1,5 @@
 apply from: "${rootDir}/gradle/publish-jar.gradle"
+
+dependencies {
+    api 'com.google.errorprone:error_prone_annotations'
+}
diff --git a/safe-logging/src/main/java/com/palantir/logsafe/SafeArg.java b/safe-logging/src/main/java/com/palantir/logsafe/SafeArg.java
@@ -16,6 +16,7 @@
 
 package com.palantir.logsafe;
 
+import com.google.errorprone.annotations.CompileTimeConstant;
 import javax.annotation.Nullable;
 
 /** A wrapper around an argument known to be safe for logging. */
@@ -25,7 +26,7 @@ private SafeArg(String name, @Nullable T value) {
         super(name, value);
     }
 
-    public static <T> SafeArg<T> of(String name, @Nullable T value) {
+    public static <T> SafeArg<T> of(@CompileTimeConstant String name, @Nullable T value) {
         return new SafeArg<>(name, value);
     }
 

diff --git a/safe-logging/src/main/java/com/palantir/logsafe/UnsafeArg.java b/safe-logging/src/main/java/com/palantir/logsafe/UnsafeArg.java
@@ -16,6 +16,7 @@
 
 package com.palantir.logsafe;
 
+import com.google.errorprone.annotations.CompileTimeConstant;
 import javax.annotation.Nullable;
 
 /** A wrapper around an argument that is not safe for logging. */
@@ -25,7 +26,7 @@ private UnsafeArg(String name, @Nullable T value) {
         super(name, value);
     }
 
-    public static <T> UnsafeArg<T> of(String name, @Nullable T value) {
+    public static <T> UnsafeArg<T> of(@CompileTimeConstant String name, @Nullable T value) {
         return new UnsafeArg<>(name, value);
     }