jenkins.scm.api

Class SCMSourceObserver.ProjectObserver

java.lang.Object

jenkins.scm.api.SCMSourceObserver.ProjectObserver

Direct Known Subclasses:

NoOpProjectObserver

Enclosing class:

SCMSourceObserver

public abstract static class SCMSourceObserver.ProjectObserver
extends Object

Nested callback produced by SCMSourceObserver.observe(java.lang.String).

Constructor Summary

Constructors

Constructor and Description
ProjectObserver()

Method Summary

Modifier and Type	Method and Description
abstract void	addAttribute(String key, Object value) Adds extra metadata about a specific project.
abstract void	addSource(SCMSource source) Adds a source repository to be used from a new project.
abstract void	complete() To be called when finished defining one project.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectObserver

public ProjectObserver()

Method Detail

addSource

public abstract void addSource(@NonNull
                               SCMSource source)

Adds a source repository to be used from a new project.

Parameters:

source - a potential SCM source as in MultiBranchProject.getSCMSources; do not call SCMSource.setOwner(jenkins.scm.api.SCMSourceOwner) on it

addAttribute

public abstract void addAttribute(@NonNull
                                  String key,
                                  @Nullable
                                  Object value)
                           throws IllegalArgumentException,
                                  ClassCastException

Adds extra metadata about a specific project. Currently no metadata keys are defined; placeholder for description, icon, URL, etc.

Parameters:

key - a predefined attribute name

value - some value, of a type defined by the attribute, perhaps null if allowed by the attribute documentation

Throws:

IllegalArgumentException - if the attribute name is unrecognized, or this attribute was already added

ClassCastException - if the attribute value is inappropriate for its type

complete

public abstract void complete()
                       throws IllegalStateException,
                              IOException,
                              InterruptedException

To be called when finished defining one project.

Throws:

IllegalStateException - may be thrown if called twice

IOException - if processing of the final project could not be completed due to an IOException.

InterruptedException - if processing of the final project was interrupted