org.drools.planner.core.termination.AbstractTermination Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of drools-planner-core Show documentation

Drools Planner optimizes automated planning by combining metaheuristic search algorithms with rule engine powered score calculation. This is the drools-planner-core module which contains metaheuristic algorithms.

There is a newer version: 6.0.0.Alpha9

Show newest version

/*
 * Copyright 2010 JBoss Inc
 *
 * 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.drools.planner.core.termination;

import org.drools.planner.core.phase.AbstractSolverPhaseScope;
import org.drools.planner.core.phase.step.AbstractStepScope;
import org.drools.planner.core.solver.DefaultSolverScope;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Abstract superclass for {@link Termination}.
 */
public abstract class AbstractTermination implements Termination {

    protected final transient Logger logger = LoggerFactory.getLogger(getClass());

    // ************************************************************************
    // Worker methods
    // ************************************************************************

    public void solvingStarted(DefaultSolverScope solverScope) {
        // Hook which can be optionally overwritten by subclasses.
    }

    public void phaseStarted(AbstractSolverPhaseScope solverPhaseScope) {
        // Hook which can be optionally overwritten by subclasses.
    }

    public void beforeDeciding(AbstractStepScope stepScope) {
        // Hook which can be optionally overwritten by subclasses.
    }

    public void stepTaken(AbstractStepScope stepScope) {
        // Hook which can be optionally overwritten by subclasses.
    }

    public void phaseEnded(AbstractSolverPhaseScope solverPhaseScope) {
        // Hook which can be optionally overwritten by subclasses.
    }

    public void solvingEnded(DefaultSolverScope solverScope) {
        // Hook which can be optionally overwritten by subclasses.
    }

}