001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.workflow.function;
021    
022    import com.google.common.annotations.Beta;
023    import org.sonar.api.workflow.MutableReview;
024    import org.sonar.api.workflow.Review;
025    import org.sonar.api.workflow.WorkflowContext;
026    
027    import java.util.Map;
028    
029    /**
030     * Functions perform actions when the command is executed, e.g.:
031     *
032     * <ul>
033     *   <li>Assign the issue to a particular user (not yet implemented)</li>
034     *   <li>Add a comment</li>
035     *   <li>Set a review property</li>
036     * </ul>
037     *
038     * @since 3.1
039     */
040    @Beta
041    public abstract class Function {
042    
043      /**
044       * This method is executed when all the conditions pass.
045       *
046       * @param review        the review that can be changed
047       * @param initialReview the read-only review as stated before execution of functions
048       * @param context       information about the user who executed the command and about project
049       * @param parameters    the command parameters sent by end user, generally from forms displayed in screens
050       */
051      public abstract void doExecute(MutableReview review, Review initialReview, WorkflowContext context, Map<String, String> parameters);
052    
053    }