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 String
INCLUDE_ALL_PATTERN
-
Constructor Summary
Constructors Constructor Description HtmlPublisherTarget(String reportName, String reportDir, String reportFiles, boolean keepAll, boolean allowMissing)
HtmlPublisherTarget(String reportName, String reportDir, String reportFiles, boolean keepAll, boolean alwaysLinkToLastBuild, boolean allowMissing)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(Object obj)
boolean
getAllowMissing()
boolean
getAlwaysLinkToLastBuild()
FilePath
getArchiveTarget(Run build)
boolean
getEscapeUnderscores()
String
getIncludes()
boolean
getKeepAll()
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 constructionstatic String
sanitizeReportName(String reportName, boolean escapeUnderscores)
void
setEscapeUnderscores(boolean escapeUnderscores)
void
setIncludes(String includes)
void
setReportName(String reportName)
void
setReportTitles(String reportTitles)
void
setUseWrapperFileDirectly(boolean useWrapperFileDirectly)
-
Methods inherited from class hudson.model.AbstractDescribableImpl
getDescriptor
-
-
-
-
Field Detail
-
INCLUDE_ALL_PATTERN
public static final String INCLUDE_ALL_PATTERN
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
HtmlPublisherTarget
@Deprecated public HtmlPublisherTarget(String reportName, String reportDir, String reportFiles, boolean keepAll, boolean allowMissing)
-
HtmlPublisherTarget
@DataBoundConstructor public HtmlPublisherTarget(String reportName, String reportDir, String reportFiles, boolean keepAll, boolean alwaysLinkToLastBuild, boolean allowMissing)
Constructor.- Parameters:
reportName
- Report namereportDir
- Source directory in the job workspacereportFiles
- Files to be publishedkeepAll
- True if the report should be stored for all buildsalwaysLinkToLastBuild
- If true, the job action will refer the latest build. Otherwise, the latest successful one will be referencedallowMissing
- If true, blocks the build failure if the report is missing- Since:
- 1.4
-
-
Method Detail
-
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()
-
setEscapeUnderscores
@DataBoundSetter public void setEscapeUnderscores(boolean escapeUnderscores)
-
getUseWrapperFileDirectly
public Boolean getUseWrapperFileDirectly()
-
setUseWrapperFileDirectly
@DataBoundSetter public void setUseWrapperFileDirectly(boolean useWrapperFileDirectly)
-
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()
-
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
-
-