Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark CSOT feature as Alpha #1372

Merged
merged 15 commits into from
May 3, 2024
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ with prior patch releases of the same minor release branch.

#### @Alpha
stIncMale marked this conversation as resolved.
Show resolved Hide resolved

APIs marked with the `@Alpha` annotation at the class, method or field level are in the early stages of development,
subject to incompatible changes, or even removal, in a future release and may lack some intended features. These APIs
may be unstable, have potential performance implications as development progresses, and are exempt from any compatibility
guarantees made by its containing library.
APIs marked with the `@Alpha` annotation at a public API element are in the early stages of development, subject to
stIncMale marked this conversation as resolved.
Show resolved Hide resolved
incompatible changes, or even removal, in a future release and may lack some intended features. An APIs bearing `@Alpha`
annotation may contain known issues affecting functionality, performance, and stability. They are also exempt from any
compatibility guarantees made by its containing library.

It is inadvisable for <i>applications</i> to use Alpha APIs in production environments or for <i>libraries</i>
(which get included on users' CLASSPATHs, outside the library developers' control) to depend on these APIs. Alpha APIs
It is inadvisable for <i>applications</i> to use Alpha APIs in production environments or for <i>libraries</i>
(which get included on users' CLASSPATHs, outside the library developers' control) to depend on these APIs. Alpha APIs
are intended for <b>experimental purposes</b> only.

#### @Beta
Expand Down
1 change: 1 addition & 0 deletions driver-core/src/main/com/mongodb/annotations/Reason.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
/**
* Enumerates the reasons an API element might be marked with annotations like {@link Alpha} or {@link Beta}.
*/
@Beta(Reason.CLIENT)
public enum Reason {
stIncMale marked this conversation as resolved.
Show resolved Hide resolved
/**
* Indicates that the status of the driver API is the reason for the annotation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

import com.mongodb.CursorType;
import com.mongodb.ExplainVerbosity;
import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.client.model.Projections;
Expand Down Expand Up @@ -288,6 +290,7 @@ public interface FindPublisher<TResult> extends Publisher<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
FindPublisher<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package com.mongodb.reactivestreams.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.lang.Nullable;
import org.bson.BsonValue;
Expand Down Expand Up @@ -96,6 +98,7 @@ public interface ListCollectionsPublisher<TResult> extends Publisher<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListCollectionsPublisher<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

package com.mongodb.reactivestreams.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.lang.Nullable;
import org.bson.BsonValue;
Expand Down Expand Up @@ -119,6 +121,7 @@ public interface ListDatabasesPublisher<TResult> extends Publisher<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListDatabasesPublisher<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package com.mongodb.reactivestreams.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.lang.Nullable;
import org.bson.BsonValue;
Expand Down Expand Up @@ -85,6 +87,7 @@ public interface ListIndexesPublisher<TResult> extends Publisher<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListIndexesPublisher<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
package com.mongodb.reactivestreams.client;

import com.mongodb.ExplainVerbosity;
import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Evolving;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
Expand Down Expand Up @@ -110,6 +112,7 @@ public interface ListSearchIndexesPublisher<TResult> extends Publisher<TResult>
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListSearchIndexesPublisher<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
package com.mongodb.reactivestreams.client;


import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
Expand Down Expand Up @@ -200,6 +202,7 @@ public interface MapReducePublisher<TResult> extends Publisher<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
MapReducePublisher<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
package com.mongodb.client;

import com.mongodb.ExplainVerbosity;
import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
Expand Down Expand Up @@ -85,6 +87,7 @@ public interface AggregateIterable<TResult> extends MongoIterable<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
AggregateIterable<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
3 changes: 3 additions & 0 deletions driver-sync/src/main/com/mongodb/client/DistinctIterable.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package com.mongodb.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
Expand Down Expand Up @@ -102,5 +104,6 @@ public interface DistinctIterable<TResult> extends MongoIterable<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
DistinctIterable<TResult> timeoutMode(TimeoutMode timeoutMode);
}
3 changes: 3 additions & 0 deletions driver-sync/src/main/com/mongodb/client/FindIterable.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

import com.mongodb.CursorType;
import com.mongodb.ExplainVerbosity;
import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.client.model.Projections;
Expand Down Expand Up @@ -281,6 +283,7 @@ public interface FindIterable<TResult> extends MongoIterable<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
FindIterable<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package com.mongodb.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.lang.Nullable;
import org.bson.BsonValue;
Expand Down Expand Up @@ -92,5 +94,6 @@ public interface ListCollectionsIterable<TResult> extends MongoIterable<TResult>
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListCollectionsIterable<TResult> timeoutMode(TimeoutMode timeoutMode);
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package com.mongodb.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.lang.Nullable;
import org.bson.BsonValue;
Expand Down Expand Up @@ -114,5 +116,6 @@ public interface ListDatabasesIterable<TResult> extends MongoIterable<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListDatabasesIterable<TResult> timeoutMode(TimeoutMode timeoutMode);
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package com.mongodb.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.lang.Nullable;
import org.bson.BsonValue;
Expand Down Expand Up @@ -81,5 +83,6 @@ public interface ListIndexesIterable<TResult> extends MongoIterable<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListIndexesIterable<TResult> timeoutMode(TimeoutMode timeoutMode);
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
package com.mongodb.client;

import com.mongodb.ExplainVerbosity;
import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Evolving;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
Expand Down Expand Up @@ -110,6 +112,7 @@ public interface ListSearchIndexesIterable<TResult> extends MongoIterable<TResul
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
ListSearchIndexesIterable<TResult> timeoutMode(TimeoutMode timeoutMode);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package com.mongodb.client;

import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.client.cursor.TimeoutMode;
import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
Expand Down Expand Up @@ -192,5 +194,6 @@ public interface MapReduceIterable<TResult> extends MongoIterable<TResult> {
* @return this
* @since CSOT
*/
@Alpha(Reason.CLIENT)
MapReduceIterable<TResult> timeoutMode(TimeoutMode timeoutMode);
}