Package org.jenkinsci.plugins.workflow.libs

Class ClasspathAdder

java.lang.Object

org.jenkinsci.plugins.workflow.libs.ClasspathAdder

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

LibraryAdder

public abstract class ClasspathAdder
extends Object
implements ExtensionPoint

Allows libraries to be mapped to actual classpath additions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClasspathAdder.Addition

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ClasspathAdder()

Method Summary

Modifier and Type	Method	Description
abstract List<ClasspathAdder.Addition>	add(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution execution, List<String> libraries, HashMap<String,Boolean> changelogs)	May add to the classpath.

Methods inherited from class java.lang.Object

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

Constructor Details

ClasspathAdder

public ClasspathAdder()

Method Details

add

@NonNull
public abstract List<ClasspathAdder.Addition> add(@NonNull
 org.jenkinsci.plugins.workflow.cps.CpsFlowExecution execution,
 @NonNull
 List<String> libraries,
 @NonNull
 HashMap<String,Boolean> changelogs)
                                           throws Exception

May add to the classpath.

Parameters:

execution - a running build (possibly newly started, possibly resumed)

libraries - aggregated entries from all encountered Library.value() (will be empty if Library is never used at all); an implementation should remove entries it “claims”

Returns:

a possibly empty list of additions

Throws:

Exception - for whatever reason (will fail compilation)