001    /*
002     * Copyright 2011 Christian Kumpe http://kumpe.de/christian/java
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *     http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package de.kumpe.hadooptimizer;
017    
018    /**
019     * Marks a {@link Halter} to be stoppable. Wich means that the evolution cycle
020     * can be intentionally canceled from the outside before the actual optimization
021     * goal is reached.
022     * 
023     * @author <a href="http://kumpe.de/christian/java">Christian Kumpe</a>
024     */
025    public interface Stoppable {
026            /**
027             * Is called once to tell the {@link Halter} the stop the evoltion cycle at
028             * the end of the current iteration.
029             */
030            void stop();
031    }