Package jenkins.branch

Class DescriptionColumn

java.lang.Object

hudson.views.ListViewColumn

jenkins.branch.DescriptionColumn

All Implemented Interfaces:

ExtensionPoint, Describable<ListViewColumn>

public class DescriptionColumn
extends ListViewColumn

ListViewColumn that shows the description text of a Job with priority given to ObjectMetadataAction.getObjectDescription().

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DescriptionColumn.DescriptorImpl	Our descriptor.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.views.ListViewColumn

DEFAULT_COLUMNS_ORDINAL_ACTIONS_END, DEFAULT_COLUMNS_ORDINAL_ACTIONS_START, DEFAULT_COLUMNS_ORDINAL_ICON_END, DEFAULT_COLUMNS_ORDINAL_ICON_START, DEFAULT_COLUMNS_ORDINAL_PROPERTIES_END, DEFAULT_COLUMNS_ORDINAL_PROPERTIES_START, LIST

Constructor Summary

Constructors

Constructor	Description
DescriptionColumn()	Constructor.

Method Summary

Modifier and Type	Method	Description
String	formattedDescription(Object p, Object job)	Gets the formatted description of a job.
jenkins.scm.api.metadata.ObjectMetadataAction	getPropertyOf(Item item)	Gets the metadata of an item.

Methods inherited from class hudson.views.ListViewColumn

all, createDefaultInitialColumnList, createDefaultInitialColumnList, createDefaultInitialColumnList, getColumnCaption, getDescriptor, shownByDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptionColumn

@DataBoundConstructor
public DescriptionColumn()

Constructor.

Method Detail

getPropertyOf

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@CheckForNull
public jenkins.scm.api.metadata.ObjectMetadataAction getPropertyOf(Item item)

Gets the metadata of an item.

Parameters:

item - the item.

Returns:

the metadata or null

formattedDescription

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String formattedDescription(@CheckForNull
                                   Object p,
                                   @NonNull
                                   Object job)
                            throws IOException

Gets the formatted description of a job.

Parameters:

p - the metadata action.

job - the job.

Returns:

the description. It is never unfiltered, unescaped HTML.

Throws:

IOException - if there was an issue encoding the description.