Stoppable.java

/*
 * Copyright 2010 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 org.gradle.internal.concurrent;

/**
 * Represents an object which performs concurrent activity.
 */
public interface Stoppable {
    /**
     * <p>Requests a graceful stop of this object. Blocks until all concurrent activity has been completed.</p>
     *
     * <p>If this object has already been stopped, this method does nothing.</p>
     */
    void stop();
}