This is an automated email from the ASF dual-hosted git repository.
zhaijia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 07bb94f ISSUE #713: Mark new API as experimental
07bb94f is described below
commit 07bb94f25a49c6f28c5b33ce930c0e2a3601db83
Author: Sijie Guo <[email protected]>
AuthorDate: Thu Nov 16 21:00:47 2017 +0800
ISSUE #713: Mark new API as experimental
Descriptions of the changes in this PR:
mark new api as experimental - `InterfaceStability.Unstable`
Author: Sijie Guo <[email protected]>
Reviewers: Ivan Kelly <[email protected]>, Enrico Olivelli
<[email protected]>, Jia Zhai <None>
This closes #736 from sijie/mark_api_experimental, closes #713
---
.../src/main/java/org/apache/bookkeeper/client/api/BKException.java | 4 ++++
.../src/main/java/org/apache/bookkeeper/client/api/BookKeeper.java | 4 ++++
.../java/org/apache/bookkeeper/client/api/BookKeeperBuilder.java | 4 ++++
.../main/java/org/apache/bookkeeper/client/api/CreateAdvBuilder.java | 5 +++++
.../main/java/org/apache/bookkeeper/client/api/CreateBuilder.java | 4 ++++
.../main/java/org/apache/bookkeeper/client/api/DeleteBuilder.java | 5 +++++
.../src/main/java/org/apache/bookkeeper/client/api/DigestType.java | 5 +++++
.../src/main/java/org/apache/bookkeeper/client/api/Handle.java | 4 ++++
.../src/main/java/org/apache/bookkeeper/client/api/LedgerEntry.java | 4 ++++
.../src/main/java/org/apache/bookkeeper/client/api/OpBuilder.java | 4 ++++
.../src/main/java/org/apache/bookkeeper/client/api/OpenBuilder.java | 4 ++++
.../src/main/java/org/apache/bookkeeper/client/api/ReadHandle.java | 4 ++++
.../main/java/org/apache/bookkeeper/client/api/WriteAdvHandle.java | 4 ++++
.../src/main/java/org/apache/bookkeeper/client/api/WriteHandle.java | 4 ++++
14 files changed, 59 insertions(+)
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BKException.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BKException.java
index cf7eda2..07bcf0f 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BKException.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BKException.java
@@ -16,12 +16,16 @@
package org.apache.bookkeeper.client.api;
import org.apache.bookkeeper.client.LedgerHandleAdv;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
/**
* Super class for all errors which occur using BookKeeper client.
*
* @since 4.6
*/
+@Public
+@Unstable
public abstract class BKException extends Exception {
protected final int code;
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeper.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeper.java
index 74cb8d3..7c4b678 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeper.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeper.java
@@ -21,6 +21,8 @@
package org.apache.bookkeeper.client.api;
import org.apache.bookkeeper.client.impl.BookKeeperBuilderImpl;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
import org.apache.bookkeeper.conf.ClientConfiguration;
/**
@@ -28,6 +30,8 @@ import org.apache.bookkeeper.conf.ClientConfiguration;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface BookKeeper extends AutoCloseable {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeperBuilder.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeperBuilder.java
index fe5bfdb..bc5fdb5 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeperBuilder.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/BookKeeperBuilder.java
@@ -23,6 +23,8 @@ package org.apache.bookkeeper.client.api;
import io.netty.channel.EventLoopGroup;
import io.netty.util.HashedWheelTimer;
import java.io.IOException;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
import org.apache.bookkeeper.feature.FeatureProvider;
import org.apache.bookkeeper.net.DNSToSwitchMapping;
import org.apache.bookkeeper.stats.StatsLogger;
@@ -33,6 +35,8 @@ import org.apache.zookeeper.ZooKeeper;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface BookKeeperBuilder {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateAdvBuilder.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateAdvBuilder.java
index d4f9ffa..1237291 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateAdvBuilder.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateAdvBuilder.java
@@ -20,12 +20,17 @@
*/
package org.apache.bookkeeper.client.api;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
+
/**
* Builder-style interface to create new ledgers.
*
* @since 4.6
* @see BookKeeper#newCreateLedgerOp()
*/
+@Public
+@Unstable
public interface CreateAdvBuilder extends OpBuilder<WriteAdvHandle> {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateBuilder.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateBuilder.java
index 6d7d1ee..cd5fd3d 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateBuilder.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/CreateBuilder.java
@@ -21,6 +21,8 @@
package org.apache.bookkeeper.client.api;
import java.util.Map;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
/**
* Builder-style interface to create new ledgers.
@@ -28,6 +30,8 @@ import java.util.Map;
* @since 4.6
* @see BookKeeper#newCreateLedgerOp()
*/
+@Public
+@Unstable
public interface CreateBuilder extends OpBuilder<WriteHandle> {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DeleteBuilder.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DeleteBuilder.java
index 0652d5c..ddbf41d 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DeleteBuilder.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DeleteBuilder.java
@@ -20,11 +20,16 @@
*/
package org.apache.bookkeeper.client.api;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
+
/**
* Builder-style interface to delete exiting ledgers.
*
* @since 4.6
*/
+@Public
+@Unstable
public interface DeleteBuilder extends OpBuilder<Void> {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DigestType.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DigestType.java
index f6c59ff..d7db214 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DigestType.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/DigestType.java
@@ -20,11 +20,16 @@
*/
package org.apache.bookkeeper.client.api;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
+
/**
* Digest type.
*
* @since 4.6
*/
+@Public
+@Unstable
public enum DigestType {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/Handle.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/Handle.java
index 86cb135..326f2e6 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/Handle.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/Handle.java
@@ -22,6 +22,8 @@ package org.apache.bookkeeper.client.api;
import java.util.concurrent.CompletableFuture;
import lombok.SneakyThrows;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
import org.apache.bookkeeper.common.concurrent.FutureUtils;
/**
@@ -29,6 +31,8 @@ import org.apache.bookkeeper.common.concurrent.FutureUtils;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface Handle extends AutoCloseable {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/LedgerEntry.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/LedgerEntry.java
index e56f6d6..97fe377 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/LedgerEntry.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/LedgerEntry.java
@@ -21,6 +21,8 @@
package org.apache.bookkeeper.client.api;
import io.netty.buffer.ByteBuf;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
import org.apache.bookkeeper.conf.ClientConfiguration;
/**
@@ -28,6 +30,8 @@ import org.apache.bookkeeper.conf.ClientConfiguration;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface LedgerEntry {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpBuilder.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpBuilder.java
index 72c569c..8a36fe6 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpBuilder.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpBuilder.java
@@ -21,6 +21,8 @@
package org.apache.bookkeeper.client.api;
import java.util.concurrent.CompletableFuture;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
import org.apache.bookkeeper.common.concurrent.FutureUtils;
/**
@@ -28,6 +30,8 @@ import org.apache.bookkeeper.common.concurrent.FutureUtils;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface OpBuilder<T> {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpenBuilder.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpenBuilder.java
index 63de713..f1e5ac8 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpenBuilder.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/OpenBuilder.java
@@ -20,6 +20,8 @@
*/
package org.apache.bookkeeper.client.api;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
import org.apache.bookkeeper.conf.ClientConfiguration;
/**
@@ -27,6 +29,8 @@ import org.apache.bookkeeper.conf.ClientConfiguration;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface OpenBuilder extends OpBuilder<ReadHandle> {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/ReadHandle.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/ReadHandle.java
index 00dfac9..7ac4645 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/ReadHandle.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/ReadHandle.java
@@ -21,12 +21,16 @@
package org.apache.bookkeeper.client.api;
import java.util.concurrent.CompletableFuture;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
/**
* Provide read access to a ledger.
*
* @since 4.6
*/
+@Public
+@Unstable
public interface ReadHandle extends Handle {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteAdvHandle.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteAdvHandle.java
index 87ba498..a324c48 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteAdvHandle.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteAdvHandle.java
@@ -24,6 +24,8 @@ import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import java.nio.ByteBuffer;
import java.util.concurrent.CompletableFuture;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
/**
* Provide write access to a ledger. Using WriteAdvHandler the writer MUST
explictly set an entryId. Beware that the
@@ -34,6 +36,8 @@ import java.util.concurrent.CompletableFuture;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface WriteAdvHandle extends ReadHandle {
/**
diff --git
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteHandle.java
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteHandle.java
index 78c249f..794d0bc 100644
---
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteHandle.java
+++
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/api/WriteHandle.java
@@ -24,6 +24,8 @@ import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import java.nio.ByteBuffer;
import java.util.concurrent.CompletableFuture;
+import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
+import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
/**
* Provide write access to a ledger.
@@ -32,6 +34,8 @@ import java.util.concurrent.CompletableFuture;
*
* @since 4.6
*/
+@Public
+@Unstable
public interface WriteHandle extends ReadHandle {
/**
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
