org.sonar.api.workflow.function

Class CommentFunction

java.lang.Object

org.sonar.api.workflow.function.Function

org.sonar.api.workflow.function.CommentFunction

@Beta
public final class CommentFunction
extends Function

Since:

3.1

Constructor Summary

Constructors

Constructor and Description
CommentFunction()

Method Summary

Methods

Modifier and Type	Method and Description
void	doExecute(MutableReview review, Review initialReview, WorkflowContext context, Map<String,String> parameters) This method is executed when all the conditions pass.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommentFunction

public CommentFunction()

Method Detail

doExecute

public void doExecute(MutableReview review,
             Review initialReview,
             WorkflowContext context,
             Map<String,String> parameters)

Description copied from class: Function

This method is executed when all the conditions pass.

Specified by:

doExecute in class Function

Parameters:

review - the review that can be changed

initialReview - the read-only review as stated before execution of functions

context - information about the user who executed the command and about project

parameters - the command parameters sent by end user, generally from forms displayed in screens