jenkins.scm.api

Class SCMSourceObserver

java.lang.Object

jenkins.scm.api.SCMSourceObserver

public abstract class SCMSourceObserver
extends Object

Callback used by SCMNavigator.

Since:

0.3-beta-1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SCMSourceObserver.ProjectObserver Nested callback produced by observe(java.lang.String).

Constructor Summary

Constructors

Constructor and Description
SCMSourceObserver()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addAttribute(String key, Object value) Adds extra metadata about the overall organization.
abstract SCMSourceOwner	getContext() Indicates who is asking for sources.
abstract hudson.model.TaskListener	getListener() Provides a way of reporting progress.
abstract SCMSourceObserver.ProjectObserver	observe(String projectName) Declare that a new “project” such as a source repository has been found.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMSourceObserver

public SCMSourceObserver()

Method Detail

getContext

@Nonnull
public abstract SCMSourceOwner getContext()

Indicates who is asking for sources.

Returns:

a contextual item, typically a OrganizationFolder

getListener

@Nonnull
public abstract hudson.model.TaskListener getListener()

Provides a way of reporting progress.

Returns:

a logger

observe

@Nonnull
public abstract SCMSourceObserver.ProjectObserver observe(@Nonnull
                                                String projectName)
                                                   throws IllegalArgumentException

Declare that a new “project” such as a source repository has been found.

Parameters:

projectName - a name of the project, such as a repository name within an organization; may be used as an Item.getName()

Returns:

a secondary callback to customize the project, on which you must call SCMSourceObserver.ProjectObserver.complete()

Throws:

IllegalArgumentException - if this projectName has already been encountered

addAttribute

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

Adds extra metadata about the overall organization. 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