hudson.plugins.reviewboard
Class ReviewInfoAction

java.lang.Object
  hudson.model.InvisibleAction
      hudson.plugins.reviewboard.ReviewInfoAction

All Implemented Interfaces:

hudson.model.Action, hudson.model.ModelObject

public class ReviewInfoAction
extends hudson.model.InvisibleAction

Constructor Summary

ReviewInfoAction(String externalID, Long changeListID, Long reviewBoardID, String author, String changeDescription)
Contains a mapping between an external ID (such as JIRA) and Reviewboard so that multiple changes can update existing review requsts instead of forcing the creation of new requests each change list pulled from the SCM.

Method Summary

protected boolean	equalsExternalID(String externalID) Compares a supplied external ID to this object's external ID to determine if they match.
String	getExternalID() Returns the external ID associated with a build
ReviewRequest	getReviewRequest() Returns the review request associated with Reviewboard

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName, getUrlName

Methods inherited from class java.lang.Object

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

Constructor Detail

ReviewInfoAction

public ReviewInfoAction(String externalID,
                        Long changeListID,
                        Long reviewBoardID,
                        String author,
                        String changeDescription)

Contains a mapping between an external ID (such as JIRA) and Reviewboard so that multiple changes can update existing review requsts instead of forcing the creation of new requests each change list pulled from the SCM. A build may have multiple ReviewInfoAction objects associated with it as multiple changelists may be captured during a build process, but each ReviewInfoAction maps to a single changelist, reviewboard ID, and external ID

Parameters:

externalID - ID from an external repository, such as JIRA

changeListID - ID from SCM associated with a builds external ID and review request ID

reviewBoardID - ID of review request in Reviewboard

author - author of change (usually the submitter of the changelist in SCM)

changeDescription - description of the change that was submit to SCM

Method Detail

getExternalID

public String getExternalID()

Returns the external ID associated with a build

Returns:

external ID (such as JIRA ID)

getReviewRequest

public ReviewRequest getReviewRequest()

Returns the review request associated with Reviewboard

Returns:

review request

equalsExternalID

protected boolean equalsExternalID(String externalID)

Compares a supplied external ID to this object's external ID to determine if they match. If they match then a review request already exists mapping this external ID to reviewboard. This will lead to the review request being updated instead of a new review being created.

Parameters:

externalID - external ID to compare against this external ID

Returns:

true if they match (case insensitive), false otherwise