Package htmlpublisher

Class HtmlPublisherTarget

java.lang.Object

hudson.model.AbstractDescribableImpl<HtmlPublisherTarget>

htmlpublisher.HtmlPublisherTarget

All Implemented Interfaces:

Describable<HtmlPublisherTarget>

public class HtmlPublisherTarget
extends AbstractDescribableImpl<HtmlPublisherTarget>

A representation of an HTML directory to archive and publish.

Author:

Mike Rooney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	HtmlPublisherTarget.BaseHTMLAction
static class	HtmlPublisherTarget.DescriptorImpl
class	HtmlPublisherTarget.HTMLAction
class	HtmlPublisherTarget.HTMLBuildAction
static class	HtmlPublisherTarget.HTMLPublishedForProjectMarkerAction	Hidden action, which indicates the build has been published on the project level.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_ALL_PATTERN

Constructor Summary

Constructors

Constructor	Description
HtmlPublisherTarget(String reportName, String reportDir, String reportFiles, boolean keepAll, boolean allowMissing)	Deprecated. Use HtmlPublisherTarget(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean).
HtmlPublisherTarget(String reportName, String reportDir, String reportFiles, boolean keepAll, boolean alwaysLinkToLastBuild, boolean allowMissing)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	getAllowMissing()
boolean	getAlwaysLinkToLastBuild()
FilePath	getArchiveTarget(Run build)
boolean	getEscapeUnderscores()
String	getIcon()
String	getIncludes()
boolean	getKeepAll()
int	getNumberOfWorkers()
Action	getProjectAction(AbstractItem item)
String	getReportDir()
String	getReportFiles()
String	getReportName()
String	getReportTitles()
String	getSanitizedName()
Boolean	getUseWrapperFileDirectly()
String	getWrapperName()
void	handleAction(Run<?,?> build)	Deprecated.
int	hashCode()
protected Object	readResolve()	Called by XStream after object construction
static String	sanitizeReportName(String reportName, boolean escapeUnderscores)
void	setEscapeUnderscores(boolean escapeUnderscores)
void	setIcon(String icon)
void	setIncludes(String includes)
void	setNumberOfWorkers(int numberOfWorkers)
void	setReportName(String reportName)
void	setReportTitles(String reportTitles)
void	setUseWrapperFileDirectly(boolean useWrapperFileDirectly)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Details

INCLUDE_ALL_PATTERN

public static final String INCLUDE_ALL_PATTERN

See Also:

• Constant Field Values

Constructor Details

HtmlPublisherTarget

@Deprecated
public HtmlPublisherTarget(String reportName,
 String reportDir,
 String reportFiles,
 boolean keepAll,
 boolean allowMissing)

Deprecated.

Use HtmlPublisherTarget(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean).

HtmlPublisherTarget

@DataBoundConstructor
public HtmlPublisherTarget(String reportName,
 String reportDir,
 String reportFiles,
 boolean keepAll,
 boolean alwaysLinkToLastBuild,
 boolean allowMissing)

Constructor.

Parameters:

reportName - Report name

reportDir - Source directory in the job workspace

reportFiles - Files to be published

keepAll - True if the report should be stored for all builds

alwaysLinkToLastBuild - If true, the job action will refer the latest build. Otherwise, the latest successful one will be referenced

allowMissing - If true, blocks the build failure if the report is missing

Since:

1.4

Method Details

getReportTitles

public String getReportTitles()

getReportName

public String getReportName()

getReportDir

public String getReportDir()

getReportFiles

public String getReportFiles()

getAlwaysLinkToLastBuild

public boolean getAlwaysLinkToLastBuild()

getKeepAll

public boolean getKeepAll()

getAllowMissing

public boolean getAllowMissing()

getEscapeUnderscores

public boolean getEscapeUnderscores()

getIcon

public String getIcon()

setIcon

@DataBoundSetter
public void setIcon(String icon)

setEscapeUnderscores

@DataBoundSetter
public void setEscapeUnderscores(boolean escapeUnderscores)

getUseWrapperFileDirectly

public Boolean getUseWrapperFileDirectly()

setUseWrapperFileDirectly

@DataBoundSetter
public void setUseWrapperFileDirectly(boolean useWrapperFileDirectly)

getNumberOfWorkers

public int getNumberOfWorkers()

setNumberOfWorkers

@DataBoundSetter
public void setNumberOfWorkers(int numberOfWorkers)

setReportTitles

@DataBoundSetter
public void setReportTitles(String reportTitles)

setReportName

public void setReportName(String reportName)

getSanitizedName

public String getSanitizedName()

sanitizeReportName

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static String sanitizeReportName(String reportName,
 boolean escapeUnderscores)

getWrapperName

public String getWrapperName()

getArchiveTarget

public FilePath getArchiveTarget(Run build)

handleAction

@Deprecated
public void handleAction(Run<?,?> build)

Deprecated.

getProjectAction

public Action getProjectAction(AbstractItem item)

getIncludes

public String getIncludes()

Returns:

the pattern for including files, default to all if no pattern specified

setIncludes

@DataBoundSetter
public void setIncludes(String includes)

Parameters:

includes - Ant GLOB pattern

readResolve

protected Object readResolve()

Called by XStream after object construction

Returns:

modified object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object