/*
 * Copyright (c) 2022-2023 nosqlbench
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.nosqlbench.engine.api.activityapi.core;

public interface Stoppable {
    /**
     * Ask this component to stop cycling. This is an asynchronous request. Once the current active cycle
     * completes, the request will cause the component to stop cooperatively.
     */
    void requestStop();

    static void stop(Object... candidates) {
        for (Object candidate : candidates) {
            if (candidate instanceof Stoppable stoppable) {
                stoppable.requestStop();
            }
        }
    }
}
