Package org.jenkinsci.plugins.workflow.libs

Class LibraryConfiguration

java.lang.Object

hudson.model.AbstractDescribableImpl<LibraryConfiguration>

org.jenkinsci.plugins.workflow.libs.LibraryConfiguration

All Implemented Interfaces:

Describable<LibraryConfiguration>

public class LibraryConfiguration
extends AbstractDescribableImpl<LibraryConfiguration>

User configuration for one library.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LibraryConfiguration.DescriptorImpl

Constructor Summary

Constructors

Constructor	Description
LibraryConfiguration(String name, LibraryRetriever retriever)

Method Summary

Modifier and Type	Method	Description
LibraryCachingConfiguration	getCachingConfiguration()
String	getDefaultVersion()	The default version to use with LibraryRetriever.retrieve(java.lang.String, java.lang.String, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener) if none other is specified.
boolean	getIncludeInChangesets()	Whether to include library changes in reported changes in a job getIncludeInChangesets().
String	getName()	Library name.
LibraryRetriever	getRetriever()
boolean	isAllowVersionOverride()	Whether jobs should be permitted to override getDefaultVersion().
boolean	isImplicit()	Whether the library should be made accessible to qualifying jobs without any explicit Library declaration.
void	setAllowVersionOverride(boolean allowVersionOverride)
void	setCachingConfiguration(LibraryCachingConfiguration cachingConfiguration)
void	setDefaultVersion(String defaultVersion)
void	setImplicit(boolean implicit)
void	setIncludeInChangesets(boolean includeInChangesets)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryConfiguration

@DataBoundConstructor
public LibraryConfiguration(String name,
                            LibraryRetriever retriever)

Method Detail

getName

public String getName()

Library name. Should match Library.value(), up to the first occurrence of @, if any.

getRetriever

public LibraryRetriever getRetriever()

getDefaultVersion

public String getDefaultVersion()

The default version to use with LibraryRetriever.retrieve(java.lang.String, java.lang.String, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener) if none other is specified.

setDefaultVersion

@DataBoundSetter
public void setDefaultVersion(String defaultVersion)

isImplicit

public boolean isImplicit()

Whether the library should be made accessible to qualifying jobs without any explicit Library declaration.

setImplicit

@DataBoundSetter
public void setImplicit(boolean implicit)

isAllowVersionOverride

public boolean isAllowVersionOverride()

Whether jobs should be permitted to override getDefaultVersion().

setAllowVersionOverride

@DataBoundSetter
public void setAllowVersionOverride(boolean allowVersionOverride)

getIncludeInChangesets

public boolean getIncludeInChangesets()

Whether to include library changes in reported changes in a job getIncludeInChangesets().

setIncludeInChangesets

@DataBoundSetter
public void setIncludeInChangesets(boolean includeInChangesets)

getCachingConfiguration

public LibraryCachingConfiguration getCachingConfiguration()

setCachingConfiguration

@DataBoundSetter
public void setCachingConfiguration(LibraryCachingConfiguration cachingConfiguration)