com.google.jenkins.plugins.metadata.scm

Class SourceMetadataExtractor.FromSCM

java.lang.Object

com.google.jenkins.plugins.metadata.scm.SourceMetadataExtractor.FromSCM

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

SourceMetadataExtractor.FromMercurialSCM, SourceMetadataExtractor.FromMultiSCM

Enclosing class:

SourceMetadataExtractor

public abstract static class SourceMetadataExtractor.FromSCM
extends Object
implements hudson.ExtensionPoint

Extension point for extracting SourceMetadata from specific SCM subclasses.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SourceMetadataExtractor.FromSCM(Class<?> supportedClass)

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.common.collect.Multimap<String,SourceMetadata>	extract(hudson.scm.SCM scm) Runs applicable registered extensions to extract metadata from the given SCM and returns them.
protected abstract com.google.common.collect.Multimap<String,SourceMetadata>	getSourceMetadata(hudson.scm.SCM scm) Extracts and returns metadata from an instance of T.
protected boolean	isApplicable(Class<?> scmClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceMetadataExtractor.FromSCM

public SourceMetadataExtractor.FromSCM(Class<?> supportedClass)

Method Detail

extract

public static com.google.common.collect.Multimap<String,SourceMetadata> extract(hudson.scm.SCM scm)

Runs applicable registered extensions to extract metadata from the given SCM and returns them.

isApplicable

protected boolean isApplicable(Class<?> scmClass)

getSourceMetadata

protected abstract com.google.common.collect.Multimap<String,SourceMetadata> getSourceMetadata(hudson.scm.SCM scm)

Extracts and returns metadata from an instance of T. After all extensions run, metadata with the same map key are merged to allow multiple extensions to contribute to a single repo's metadata.

Parameters:

scm - SCM instance to extract metadata from; will be assignable to the supportedClass passed to the FromSCM constructor.