com.consol.citrus.container.StopTimer Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2006-2015 the original author or authors.
 *
 * 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 com.consol.citrus.container;

/**
 * Interface for stopping a timer.
 * @author Martin Maher
 * @since 2.5
 */
public interface StopTimer {
    /**
     * Sends a signal to the timer to stop. If the timer happens to be executing its nested actions,
     * then it will continue until all nested actions have completed.
     */
    void stopTimer();
}