jenkins.branch

Class MultiBranchProject.BranchIndexing<P extends hudson.model.AbstractProject<P,R> & hudson.model.TopLevelItem,R extends hudson.model.AbstractBuild<P,R>>

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

jenkins.branch.MultiBranchProject.BranchIndexing<P,R>

Type Parameters:

P - the type of project that the branch projects consist of.

R - the type of runs that the branch projects use.

All Implemented Interfaces:

hudson.model.ModelObject, hudson.model.Queue.Executable, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, Runnable, jenkins.model.ModelObjectWithContextMenu

Enclosing class:

MultiBranchProject<P extends hudson.model.AbstractProject<P,R> & hudson.model.TopLevelItem,R extends hudson.model.AbstractBuild<P,R>>

public static class MultiBranchProject.BranchIndexing<P extends hudson.model.AbstractProject<P,R> & hudson.model.TopLevelItem,R extends hudson.model.AbstractBuild<P,R>>
extends hudson.model.Actionable
implements hudson.model.Queue.Executable, hudson.model.Saveable

Represents the branch indexing job.

Nested Class Summary

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

jenkins.model.ModelObjectWithContextMenu.ContextMenu, jenkins.model.ModelObjectWithContextMenu.MenuItem

Field Summary

Fields

Modifier and Type	Field and Description
protected String	charset Charset in which the log file is written.

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
MultiBranchProject.BranchIndexing(MultiBranchProject.BranchIndexing<P,R> previousIndexing) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	doConsoleText(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Renders the progressive console log.
String	getBuildStatusUrl() Returns the build status icon URL.
hudson.model.Node	getBuiltOn() Returns a Slave on which this build was done.
String	getBuiltOnStr() Returns the name of the slave it was built on; null or "" if built by the master.
List<hudson.model.Cause>	getCauses() Returns the Causes that triggered a build.
Charset	getCharset() Gets the charset in which the log file is written.
String	getDisplayName()
String	getDurationString() Gets the string that says how long the build took to run.
long	getEstimatedDuration()
hudson.model.BallColor	getIconColor() Gets the icon color for display.
File	getLogFile() Returns the log file.
InputStream	getLogInputStream() Returns an input stream that reads from the log file.
Reader	getLogReader() Returns a Reader of the log content.
hudson.console.AnnotatedLargeText	getLogText() Used to URL-bind AnnotatedLargeText.
String	getName() Returns the name of this MultiBranchProject.BranchIndexing's parent.
MultiBranchProject<P,R>	getParent() Returns the parent.
hudson.model.Result	getPreviousResult() Returns the previous Result or null if there is none.
MultiBranchProject<P,R>	getProject() Returns the parent.
hudson.model.Result	getResult() Returns the result of indexing.
String	getSearchUrl()
Date	getTime() Same as getTimestamp() but in a different type.
long	getTimeInMillis() Same as getTimestamp() but in a different type, that is since the time of the epoc.
Calendar	getTimestamp() When the build is scheduled.
String	getTimestampString() Gets the string that says how long since this build has started.
String	getTimestampString2() Returns the timestamp formatted in xs:dateTime.
String	getUrl() Mimic method.
boolean	isBuilding() Returns true if this indexing is in progress.
boolean	isLogUpdated() Returns true if the log file is still being updated.
void	run()
void	save() Save the settings to a file.
void	setProject(MultiBranchProject<P,R> project) Sets the parent.
void	writeLogTo(long offset, org.apache.commons.jelly.XMLOutput out) Used from console.jelly to write annotated log to the given output.
void	writeWholeLogTo(OutputStream out) Writes the complete log from the start to finish to the OutputStream.

Methods inherited from class hudson.model.Actionable

addAction, doContextMenu, getAction, getAction, getActions, getActions, getDynamic

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Queue.Executable

toString

Field Detail

charset

@CheckForNull
protected String charset

Charset in which the log file is written. For compatibility reason, this field may be null. For persistence, this field is string and not Charset.

See Also:

getCharset()

Constructor Detail

MultiBranchProject.BranchIndexing

public MultiBranchProject.BranchIndexing(@CheckForNull
                                 MultiBranchProject.BranchIndexing<P,R> previousIndexing)

Constructor.

Parameters:

previousIndexing - any previous indexing.

Method Detail

getProject

@CheckForNull
public MultiBranchProject<P,R> getProject()

Returns the parent.

Returns:

the parent.

getParent

@CheckForNull
public MultiBranchProject<P,R> getParent()

Returns the parent.

Specified by:

getParent in interface hudson.model.Queue.Executable

Returns:

the parent.

setProject

public void setProject(@CheckForNull
              MultiBranchProject<P,R> project)

Sets the parent.

Parameters:

project - the parent.

save

public void save()
          throws IOException

Save the settings to a file.

Specified by:

save in interface hudson.model.Saveable

Throws:

IOException

getLogFile

@CheckForNull
public File getLogFile()

Returns the log file.

Returns:

the log file.

isBuilding

public boolean isBuilding()

Returns true if this indexing is in progress.

Returns:

true if this indexing is in progress.

isLogUpdated

public boolean isLogUpdated()

Returns true if the log file is still being updated.

getName

@CheckForNull
public String getName()

Returns the name of this MultiBranchProject.BranchIndexing's parent.

Returns:

the name of this MultiBranchProject.BranchIndexing's parent.

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrl

public String getUrl()

Mimic method.

Returns:

the URL of the indexing.

getBuiltOn

public hudson.model.Node getBuiltOn()

Returns a Slave on which this build was done.

Returns:

null, for example if the slave that this build run no longer exists.

getBuiltOnStr

@Exported(name="builtOn")
public String getBuiltOnStr()

Returns the name of the slave it was built on; null or "" if built by the master. (null happens when we read old record that didn't have this information.)

getCharset

@NonNull
public final Charset getCharset()

Gets the charset in which the log file is written.

Returns:

never null.

getLogText

@NonNull
public hudson.console.AnnotatedLargeText getLogText()

Used to URL-bind AnnotatedLargeText.

getLogInputStream

@NonNull
public InputStream getLogInputStream()
                              throws IOException

Returns an input stream that reads from the log file. It will use a gzip-compressed log file (log.gz) if that exists.

Returns:

an input stream from the log file, or null if none exists

Throws:

IOException

getLogReader

@NonNull
public Reader getLogReader()
                    throws IOException

Returns a Reader of the log content.

Returns:

a Reader of the log content.

Throws:

IOException - if the log content cannot be read.

doConsoleText

public void doConsoleText(org.kohsuke.stapler.StaplerRequest req,
                 org.kohsuke.stapler.StaplerResponse rsp)
                   throws IOException

Renders the progressive console log.

Parameters:

req - the request.

rsp - the response.

Throws:

IOException - if things go wrong.

writeLogTo

public void writeLogTo(long offset,
              org.apache.commons.jelly.XMLOutput out)
                throws IOException

Used from console.jelly to write annotated log to the given output.

Throws:

IOException

writeWholeLogTo

public void writeWholeLogTo(OutputStream out)
                     throws IOException,
                            InterruptedException

Writes the complete log from the start to finish to the OutputStream.

If someone is still writing to the log, this method will not return until the whole log file gets written out.

Throws:

IOException

InterruptedException

getBuildStatusUrl

public String getBuildStatusUrl()

Returns the build status icon URL.

Returns:

the build status icon URL.

getCauses

public List<hudson.model.Cause> getCauses()

Returns the Causes that triggered a build.

If a build sits in the queue for a long time, multiple build requests made during this period are all rolled up into one build, hence this method may return a list.

Returns:

can be empty but never null. read-only.

getResult

@Exported
@NonNull
public hudson.model.Result getResult()

Returns the result of indexing.

Returns:

the result of indexing.

getTimestamp

@Exported
@NonNull
public Calendar getTimestamp()

When the build is scheduled.

getTime

@NonNull
public final Date getTime()

Same as getTimestamp() but in a different type.

getTimeInMillis

public final long getTimeInMillis()

Same as getTimestamp() but in a different type, that is since the time of the epoc.

getTimestampString

@NonNull
public String getTimestampString()

Gets the string that says how long since this build has started.

Returns:

string like "3 minutes" "1 day" etc.

getTimestampString2

@NonNull
public String getTimestampString2()

Returns the timestamp formatted in xs:dateTime.

getDurationString

@NonNull
public String getDurationString()

Gets the string that says how long the build took to run.

getIconColor

public hudson.model.BallColor getIconColor()

Gets the icon color for display.

run

public void run()

Specified by:

run in interface hudson.model.Queue.Executable

Specified by:

run in interface Runnable

getEstimatedDuration

public long getEstimatedDuration()

Specified by:

getEstimatedDuration in interface hudson.model.Queue.Executable

getSearchUrl

public String getSearchUrl()

Specified by:

getSearchUrl in interface hudson.search.SearchItem

getPreviousResult

@CheckForNull
public hudson.model.Result getPreviousResult()

Returns the previous Result or null if there is none.

Returns:

the previous Result or null if there is none.