/*
 * 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.optaplanner.core.impl.heuristic.move;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import org.optaplanner.core.impl.score.director.ScoreDirector;

/**
 * A CompositeMove is composed out of multiple other moves.
 * <p/>
 * Warning: one of the moveList moves should not rely on the effect on of a previous moveList move
 * to create an uncorrupted undoMove.
 * @see Move
 */
public class CompositeMove implements Move {

    protected List<Move> moveList;

    /**
     * @param moveList cannot be null
     */
    public CompositeMove(List<Move> moveList) {
        this.moveList = moveList;
    }

    public List<Move> getMoveList() {
        return moveList;
    }

    public boolean isMoveDoable(ScoreDirector scoreDirector) {
        for (Move move : moveList) {
            if (!move.isMoveDoable(scoreDirector)) {
                return false;
            }
        }
        return true;
    }

    public Move createUndoMove(ScoreDirector scoreDirector) {
        List<Move> undoMoveList = new ArrayList<Move>(moveList.size());
        for (Move move : moveList) {
            // Note: this undoMove doesn't have the affect of a previous move in the moveList
            // This could be made possible by merging the methods createUndoMove and doMove...
            Move undoMove = move.createUndoMove(scoreDirector);
            undoMoveList.add(undoMove);
        }
        // TODO performance leak: use a reversed view instead, for example guava's Lists.reverse(List)
        Collections.reverse(undoMoveList);
        return new CompositeMove(undoMoveList);
    }

    public void doMove(ScoreDirector scoreDirector) {
        for (Move move : moveList) {
            move.doMove(scoreDirector);
        }
    }

    public Collection<? extends Object> getPlanningEntities() {
        Set<Object> entities = new LinkedHashSet<Object>(moveList.size() * 2);
        for (Move move : moveList) {
            entities.addAll(move.getPlanningEntities());
        }
        return entities;
    }

    public Collection<? extends Object> getPlanningValues() {
        Set<Object> values = new LinkedHashSet<Object>(moveList.size() * 2);
        for (Move move : moveList) {
            values.addAll(move.getPlanningValues());
        }
        return values;
    }

    public boolean equals(Object o) {
        if (this == o) {
            return true;
        } else if (o instanceof CompositeMove) {
            CompositeMove other = (CompositeMove) o;
            return moveList.equals(other.moveList);
        } else {
            return false;
        }
    }

    public int hashCode() {
        return moveList.hashCode();
    }

    public String toString() {
        return moveList.toString();
    }

}

@@ -956,14 +956,24 @@
 ng: 
-one of
+each of moves in
  the
@@ -987,19 +987,11 @@
 st m
-oves should
+ust
  not
@@ -1010,19 +1010,16 @@
  effect 
-on 
 of a pre
@@ -1032,17 +1032,24 @@
 move
-List
+ in the
  move
+List
 %0A * 
@@ -1062,31 +1062,30 @@
 ate 
-an uncorrupted undoMove
+its undoMove correctly
 .%0A *
@@ -1159,16 +1159,22 @@
 otected 
+final 
 List%3CMov
@@ -1222,17 +1222,13 @@
 ist 
-cannot be
+never
  nul
@@ -1318,32 +1318,74 @@
 oveList;%0A    %7D%0A%0A
+    /**%0A     * @return never null%0A     */%0A
     public List%3C
@@ -1879,16 +1879,25 @@
 ndoMove 
+creation 
 doesn't 
@@ -1909,15 +1909,19 @@
 the 
-a
+e
 ffect 
+yet 
 of a
@@ -1955,103 +1955,8 @@
 ist%0A
-            // This could be made possible by merging the methods createUndoMove and doMove...%0A
     

clean up CompositeMove