Package org.jenkinsci.plugins.builduser.varsetter.impl

Class BranchIndexingTriggerDeterminant

java.lang.Object

org.jenkinsci.plugins.builduser.varsetter.impl.BranchIndexingTriggerDeterminant

All Implemented Interfaces:

IUsernameSettable<jenkins.branch.BranchIndexingCause>

public class BranchIndexingTriggerDeterminant
extends Object
implements IUsernameSettable<jenkins.branch.BranchIndexingCause>

Field Summary

Fields inherited from interface org.jenkinsci.plugins.builduser.varsetter.IUsernameSettable

BUILD_USER_EMAIL, BUILD_USER_FIRST_NAME_VAR_NAME, BUILD_USER_ID, BUILD_USER_LAST_NAME_VAR_NAME, BUILD_USER_VAR_GROUPS, BUILD_USER_VAR_NAME, UNDEFINED

Constructor Summary

Constructors

Constructor	Description
BranchIndexingTriggerDeterminant()

Method Summary

Modifier and Type	Method	Description
Class<jenkins.branch.BranchIndexingCause>	getUsedCauseClass()	Returns Cause subclass used to determine user name.
boolean	setJenkinsUserBuildVars(jenkins.branch.BranchIndexingCause cause, Map<String,String> variables)	Adds username build variables extracted from build cause to map of build variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchIndexingTriggerDeterminant

public BranchIndexingTriggerDeterminant()

Method Detail

setJenkinsUserBuildVars

public boolean setJenkinsUserBuildVars(jenkins.branch.BranchIndexingCause cause,
                                       Map<String,String> variables)

Description copied from interface: IUsernameSettable

Adds username build variables extracted from build cause to map of build variables.

Specified by:

setJenkinsUserBuildVars in interface IUsernameSettable<jenkins.branch.BranchIndexingCause>

Parameters:

cause - cause where to get username from.

variables - map of build variables, where to add username variables.

Returns:

true if username was determined and added to the passed map, false otherwise.

getUsedCauseClass

public Class<jenkins.branch.BranchIndexingCause> getUsedCauseClass()

Description copied from interface: IUsernameSettable

Returns Cause subclass used to determine user name.

Specified by:

getUsedCauseClass in interface IUsernameSettable<jenkins.branch.BranchIndexingCause>

Returns:

class used to determine user name.