org.jenkinsci.plugins.build_view_column

Class BuildViewColumn

java.lang.Object

hudson.model.AbstractDescribableImpl<BuildViewColumn>

org.jenkinsci.plugins.build_view_column.BuildViewColumn

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<BuildViewColumn>

Direct Known Subclasses:

CauseColumn, ConsoleColumn, DurationColumn, NodeColumn

public abstract class BuildViewColumn
extends hudson.model.AbstractDescribableImpl<BuildViewColumn>
implements hudson.ExtensionPoint

Extension point for adding a column to a table rendering of Runs.

This object must have the column.groovy. This view is called for each cell of this column. The Run object is passed in the "run" variable. The view should render a <lt>td<gt> tag.

The implementation should handle run==null situation gracefully (for example by rendering an empty <lt>td<gt> tag.) As a special case of run==null, the caller of BuildViewColumn can pass in job that points to a Job that represents a build that's yet to happen. An implementation can choose to display something comparable in such a case.

This object may have an additional columnHeader.groovy. The default column header will render getColumnCaption().

Since:

1.279

Author:

Kohsuke Kawaguchi

See Also:

ListViewColumnDescriptor

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
BuildViewColumn()

Method Summary

Modifier and Type	Method and Description
String	getColumnCaption() Returns the name of the column that explains what this column means
BuildViewColumnDescriptor	getDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildViewColumn

public BuildViewColumn()

Method Detail

getColumnCaption

@Exported
public String getColumnCaption()

Returns the name of the column that explains what this column means

Returns:

The convention is to use capitalization like "Foo Bar Zot".

getDescriptor

public BuildViewColumnDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<BuildViewColumn>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<BuildViewColumn>