Merge pull request #63 from DeployGate/feat/add_experimental_annotation

Annotate experimental elements with new annotations

Author: jmatsu

sdk/src/main/java/com/deploygate/sdk/CustomLogConfiguration.java

@@ -1,8 +1,11 @@
 package com.deploygate.sdk;
 
 import com.deploygate.sdk.internal.Logger;
+import com.deploygate.sdk.internal.annotations.Experimental;
 
+@Experimental
 public class CustomLogConfiguration {
+    @Experimental
     public enum Backpressure {
         /**
          * SDK rejects new logs if buffer size is exceeded
@@ -43,6 +46,7 @@ private CustomLogConfiguration(
         this.bufferSize = bufferSize;
     }
 
+    @Experimental
     public static class Builder {
         private Backpressure backpressure = Backpressure.DROP_BUFFER_BY_OLDEST;
         private int bufferSize = DEFAULT_BUFFER_SIZE;

sdk/src/main/java/com/deploygate/sdk/LogcatProcess.java

@@ -4,6 +4,7 @@
 import android.util.Pair;
 
 import com.deploygate.sdk.internal.Logger;
+import com.deploygate.sdk.internal.annotations.Experimental;
 
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -57,7 +58,7 @@ void emit(
      * @return a pair of watcher ids (non-nulls). first is the previous watcher id, second is the new watcher id.
      */
     Pair<String, String> execute(
-            String streamSessionKey
+            @Experimental String streamSessionKey
     ) {
         Pair<String, String> ids;
 
@@ -125,7 +126,7 @@ static class LogcatWatcher implements Runnable {
         private final AtomicInteger state;
 
         LogcatWatcher(
-                String streamSessionKey,
+                @Experimental String streamSessionKey,
                 Callback callback
         ) {
             this.processId = streamSessionKey != null ? streamSessionKey : ClientId.generate();

sdk/src/main/java/com/deploygate/sdk/internal/annotations/Experimental.java

@@ -0,0 +1,23 @@
+package com.deploygate.sdk.internal.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotate elements that we may change the API until making it stable.
+ */
+@Documented
+@Target({
+        ElementType.ANNOTATION_TYPE,
+        ElementType.CONSTRUCTOR,
+        ElementType.FIELD,
+        ElementType.METHOD,
+        ElementType.PARAMETER,
+        ElementType.TYPE
+})
+@Retention(RetentionPolicy.CLASS)
+public @interface Experimental {}
+