org.sonar.api.workflow.function

Class Function

java.lang.Object

org.sonar.api.workflow.function.Function

Direct Known Subclasses:

CommentFunction

@Beta
public abstract class Function
extends Object

Functions perform actions when the command is executed, e.g.:

• Assign the issue to a particular user (not yet implemented)
• Add a comment
• Set a review property

Since:

3.1

Constructor Summary

Constructors

Constructor and Description
Function()

Method Summary

Methods

Modifier and Type	Method and Description
abstract 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

Function

public Function()

Method Detail

doExecute

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

This method is executed when all the conditions pass.

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