Package hudson.plugins.doclinks.artifacts

Class ArtifactsDocLinksConfig

java.lang.Object

hudson.plugins.doclinks.artifacts.ArtifactsDocLinksConfig

All Implemented Interfaces:

Describable<ArtifactsDocLinksConfig>

public class ArtifactsDocLinksConfig
extends Object
implements Describable<ArtifactsDocLinksConfig>

An entry for artifact documents configured by a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArtifactsDocLinksConfig.DescriptorImpl

Constructor Summary

Constructors

Constructor	Description
ArtifactsDocLinksConfig(String title, String artifactsPattern, String initialPath, String indexFile)

Method Summary

Modifier and Type	Method	Description
String	getArtifactsPattern()	Returns ant file name pattern to specify artifacts.
ArtifactsDocLinksConfig.DescriptorImpl	getDescriptor()
String	getIndexFile()	The file used for access to a directory.
String	getInitialPath()	The initial path when accessed to this artifact.
String	getTitle()
Collection<String>	scanArtifacts(AbstractBuild<?,?> build)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactsDocLinksConfig

@DataBoundConstructor
public ArtifactsDocLinksConfig(String title,
                               String artifactsPattern,
                               String initialPath,
                               String indexFile)

Parameters:

title -

artifactsPattern -

initialPath -

indexFile -

Method Detail

getTitle

public String getTitle()

Returns:

the title

getArtifactsPattern

public String getArtifactsPattern()

Returns ant file name pattern to specify artifacts.

Returns:

the artifactsPattern

getInitialPath

public String getInitialPath()

The initial path when accessed to this artifact.

Returns:

the initialPath

getIndexFile

public String getIndexFile()

The file used for access to a directory.

Returns:

the indexFile

getDescriptor

public ArtifactsDocLinksConfig.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<ArtifactsDocLinksConfig>

Returns:

See Also:

Describable.getDescriptor()

scanArtifacts

public Collection<String> scanArtifacts(AbstractBuild<?,?> build)