jenkins.branch

Class Branch

java.lang.Object

jenkins.branch.Branch

Direct Known Subclasses:

Branch.Dead

public class Branch
extends Object

A source code branch.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Branch.Dead Represents a dead branch.

Constructor Summary

Constructors

Constructor and Description
Branch(String sourceId, jenkins.scm.api.SCMHead head, hudson.scm.SCM scm, List<? extends BranchProperty> properties) Constructs a branch instance.

Method Summary

Methods

Modifier and Type	Method and Description
Map<hudson.model.Descriptor<hudson.tasks.BuildWrapper>,hudson.tasks.BuildWrapper>	configureBuildWrappers(Map<hudson.model.Descriptor<hudson.tasks.BuildWrapper>,hudson.tasks.BuildWrapper> wrappers) Takes the supplied build wrappers and gives each BranchProperty the option to contribute to the result.
<JobT extends hudson.model.Job<?,?>> List<hudson.model.JobProperty<? super JobT>>	configureJobProperties(List<hudson.model.JobProperty<? super JobT>> jobProperties) Takes the supplied job properties and gives each BranchProperty the option to contribute to the result.
Map<hudson.model.Descriptor<hudson.tasks.Publisher>,hudson.tasks.Publisher>	configurePublishers(Map<hudson.model.Descriptor<hudson.tasks.Publisher>,hudson.tasks.Publisher> publishers) Takes the supplied publishers and gives each BranchProperty the option to contribute to the result.
boolean	equals(Object o)
jenkins.scm.api.SCMHead	getHead() Returns the of the branch
String	getName() Returns the name of the branch.
List<BranchProperty>	getProperties() Gets all the properties.
<T extends BranchProperty> T	getProperty(Class<T> clazz) Gets the specific property, or null if no such property is found.
hudson.scm.SCM	getScm() Returns the SCM for the branch.
String	getSourceId() Returns the SCMSource.getId() that this branch originates from.
int	hashCode()
boolean	hasProperty(Class<? extends BranchProperty> clazz) Tests if a property of a specific type is present.
boolean	isBuildable() Returns true iff the branch is can be built.

Methods inherited from class java.lang.Object

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

Constructor Detail

Branch

public Branch(String sourceId,
      jenkins.scm.api.SCMHead head,
      hudson.scm.SCM scm,
      List<? extends BranchProperty> properties)

Constructs a branch instance.

Parameters:

sourceId - the SCMSource.getId()

head - the name of the branch.

scm - the SCM for the branch.

Method Detail

getSourceId

public String getSourceId()

Returns the SCMSource.getId() that this branch originates from.

Returns:

the SCMSource.getId() that this branch originates from.

getName

public String getName()

Returns the name of the branch.

Returns:

the name of the branch.

getHead

public jenkins.scm.api.SCMHead getHead()

Returns the of the branch

Returns:

the of the branch

getScm

public hudson.scm.SCM getScm()

Returns the SCM for the branch.

Returns:

the SCM for the branch.

hasProperty

public boolean hasProperty(Class<? extends BranchProperty> clazz)

Tests if a property of a specific type is present.

Parameters:

clazz - the specific property type

Returns:

true if and only if there is a property of the specified type.

getProperty

public <T extends BranchProperty> T getProperty(Class<T> clazz)

Gets the specific property, or null if no such property is found.

getProperties

public List<BranchProperty> getProperties()

Gets all the properties.

configurePublishers

public Map<hudson.model.Descriptor<hudson.tasks.Publisher>,hudson.tasks.Publisher> configurePublishers(Map<hudson.model.Descriptor<hudson.tasks.Publisher>,hudson.tasks.Publisher> publishers)

Takes the supplied publishers and gives each BranchProperty the option to contribute to the result.

Parameters:

publishers - the suggested publishers.

Returns:

the configured final publishers.

configureBuildWrappers

public Map<hudson.model.Descriptor<hudson.tasks.BuildWrapper>,hudson.tasks.BuildWrapper> configureBuildWrappers(Map<hudson.model.Descriptor<hudson.tasks.BuildWrapper>,hudson.tasks.BuildWrapper> wrappers)

Takes the supplied build wrappers and gives each BranchProperty the option to contribute to the result.

Parameters:

wrappers - the suggested build wrappers.

Returns:

the configured final build wrappers.

configureJobProperties

public <JobT extends hudson.model.Job<?,?>> List<hudson.model.JobProperty<? super JobT>> configureJobProperties(List<hudson.model.JobProperty<? super JobT>> jobProperties)

Takes the supplied job properties and gives each BranchProperty the option to contribute to the result.

Parameters:

jobProperties - the suggested job properties.

Returns:

the configured final job properties.

isBuildable

public boolean isBuildable()

Returns true iff the branch is can be built.

Returns:

true iff the branch is can be built.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object