jenkins.scm.impl

Class NoOpProjectObserver

java.lang.Object

jenkins.scm.api.SCMSourceObserver.ProjectObserver

jenkins.scm.impl.NoOpProjectObserver

public class NoOpProjectObserver
extends SCMSourceObserver.ProjectObserver

A SCMSourceObserver.ProjectObserver that does nothing.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
NoOpProjectObserver()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpProjectObserver

public NoOpProjectObserver()

Method Detail

instance

public static NoOpProjectObserver instance()

Returns the singleton instance.

Returns:

the singleton instance.

addSource

public void addSource(@NonNull
                      SCMSource source)

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

Specified by:

addSource in class SCMSourceObserver.ProjectObserver

Parameters:

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

addAttribute

public 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.

Specified by:

addAttribute in class SCMSourceObserver.ProjectObserver

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 void complete()
              throws IllegalStateException,
                     InterruptedException

To be called when finished defining one project.

Specified by:

complete in class SCMSourceObserver.ProjectObserver

Throws:

IllegalStateException - may be thrown if called twice

InterruptedException - if processing of the final project was interrupted