/*
* Copyright 2012 Red Hat, Inc. and/or its affiliates.
*
* 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.optaplanner.core.impl.heuristic.selector.common.decorator;
import org.optaplanner.core.api.domain.entity.PlanningEntity;
import org.optaplanner.core.api.domain.solution.PlanningSolution;
import org.optaplanner.core.impl.heuristic.move.Move;
import org.optaplanner.core.impl.heuristic.selector.Selector;
import org.optaplanner.core.impl.score.director.ScoreDirector;
/**
* Decides on keeping or discarding a selection
* (which is a {@link PlanningEntity}, a planningValue, a {@link Move} or a {@link Selector}).
* <p>
* A filtered selection is considered as not selected, it does not count as an unaccepted selection.
* @param <Solution_> the solution type, the class with the {@link PlanningSolution} annotation
* @param <T> the selection type
*/
public interface SelectionFilter<Solution_, T> {
/**
* @param scoreDirector never null, the {@link ScoreDirector}
* which has the {@link ScoreDirector#getWorkingSolution()} to which the selection belongs or applies to
* @param selection never null, a {@link PlanningEntity}, a planningValue, a {@link Move} or a {@link Selector}
* @return true if the selection is accepted, false if the selection should be discarded
*/
boolean accept(ScoreDirector<Solution_> scoreDirector, T selection);
}