Skip to content

Commit

Permalink
temporarily remove annotation
Browse files Browse the repository at this point in the history
  • Loading branch information
npepinpe committed Sep 24, 2022
1 parent 5764005 commit a8185b0
Showing 1 changed file with 16 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import io.zeebe.containers.cluster.ZeebeCluster;
import io.zeebe.containers.exporter.DebugReceiver;
import java.time.Duration;
import javax.annotation.WillClose;
import org.apiguardian.api.API;
import org.apiguardian.api.API.Status;
import org.testcontainers.containers.GenericContainer;
Expand All @@ -38,19 +37,6 @@
@API(status = Status.EXPERIMENTAL)
public interface ContainerEngine extends Startable, ZeebeTestEngine {

/**
* Marks all records with a position less than {@code position} on partition with ID {@code
* partitionId} as acknowledged, meaning they can now be deleted from Zeebe.
*
* <p>Note that this is not a synchronous operation, but instead will take effect when the next
* record is exported. See {@link io.zeebe.containers.exporter.DebugReceiver#acknowledge(int,
* long)} for more.
*
* @param partitionId the ID of the partition on which to acknowledge
* @param position the position up to which they should be acknowledged
*/
void acknowledge(final int partitionId, final long position);

/**
* Returns a default builder. Calling {@link Builder#build()} on a fresh builder will return a
* builder wrapping a default {@link io.zeebe.containers.ZeebeContainer}, with an idle period of 1
Expand All @@ -72,6 +58,19 @@ static ContainerEngine createDefault() {
return builder().build();
}

/**
* Marks all records with a position less than {@code position} on partition with ID {@code
* partitionId} as acknowledged, meaning they can now be deleted from Zeebe.
*
* <p>Note that this is not a synchronous operation, but instead will take effect when the next
* record is exported. See {@link io.zeebe.containers.exporter.DebugReceiver#acknowledge(int,
* long)} for more.
*
* @param partitionId the ID of the partition on which to acknowledge
* @param position the position up to which they should be acknowledged
*/
void acknowledge(final int partitionId, final long position);

/**
* A helper class to build {@link ContainerEngine} instances. A fresh, non-configured builder will
* always return one which has an idle period of 1 second, and uses a default {@link
Expand All @@ -95,7 +94,7 @@ interface Builder {
* io.zeebe.containers.ZeebeContainer}
*/
<T extends GenericContainer<T> & ZeebeGatewayNode<T> & ZeebeBrokerNode<T>>
Builder withContainer(@WillClose final T container);
Builder withContainer(final T container);

/**
* Sets the given cluster to be used as engine(s)/gateway(s).
Expand All @@ -111,7 +110,7 @@ interface Builder {
* @param cluster the cluster to wrap
* @return itself for chaining
*/
Builder withCluster(@WillClose final ZeebeCluster cluster);
Builder withCluster(final ZeebeCluster cluster);

/**
* Sets the idle period of the engine, used when calling {@link
Expand Down Expand Up @@ -185,7 +184,7 @@ interface Builder {
* @param receiver the debug receiver to use
* @return itself for chaining
*/
Builder withDebugReceiver(@WillClose final DebugReceiver receiver);
Builder withDebugReceiver(final DebugReceiver receiver);

/**
* Builds a {@link ContainerEngine} based on the configuration. If nothing else was called, will
Expand Down

0 comments on commit a8185b0

Please sign in to comment.