com.github.mjdetullio.jenkins.plugins.multibranch

Class BranchListView

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.View

hudson.model.ListView

com.github.mjdetullio.jenkins.plugins.multibranch.BranchListView

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.View>, hudson.model.DirectlyModifiableView, hudson.model.ModelObject, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithChildren

public class BranchListView
extends hudson.model.ListView

Wrapper for ListView that provides additional support for listing branches in multi-branch projects. The most important component is the addition of getBranch(String). Without it, non-primary views would not have a Stapler URL binding, resulting in broken links to branches.

Author:

Matthew DeTullio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BranchListView.DescriptorImpl Our descriptor that is simply a duplicate of the normal ListView descriptor.

Nested classes/interfaces inherited from class hudson.model.ListView

hudson.model.ListView.Listener

Nested classes/interfaces inherited from class hudson.model.View

hudson.model.View.AsynchPeople, hudson.model.View.People, hudson.model.View.PropertyList, hudson.model.View.UserInfo

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.View

CONFIGURE, CREATE, DELETE, description, filterExecutors, filterQueue, LIST, name, NEW_PRONOUN, owner, PERMISSIONS, READ, SORTER, transientActions

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
BranchListView(String name) Constructor used for loading objects of this type.
BranchListView(String name, hudson.model.ViewGroup owner) Constructor used to instantiate new views with an owner.

Method Summary

Modifier and Type	Method and Description
void	doCreateItem() Stapler URL binding
void	doNewJob() Stapler URL binding
hudson.model.TopLevelItem	getBranch(String name) Alias for View.getItem(String).
String	getConfigureUrl() Used by Jelly to get the correct configure URL when linking from views with no jobs.
static void	registerXStream() Gives this class an alias for configuration XML.

Methods inherited from class hudson.model.ListView

add, contains, doAddJobToView, doCreateItem, doRemoveJobFromView, getColumns, getDefaultColumns, getIncludeRegex, getItems, getJobFilters, getStatusFilter, hasJobFilterExtensions, initColumns, initJobFilters, isRecurse, jobNamesContains, remove, setIncludeRegex, setRecurse, submit

Methods inherited from class hudson.model.View

all, allInstantiable, checkPermission, create, createViewFromXML, doChildrenContextMenu, doConfigDotXml, doConfigSubmit, doDoDelete, doRssAll, doRssFailed, doRssLatest, doSubmitDescription, getAbsoluteUrl, getACL, getActions, getAllItems, getAllProperties, getApi, getApplicablePropertyDescriptors, getApproximateQueueItemsQuickly, getAsynchPeople, getBuilds, getComputers, getDescription, getDescriptor, getDisplayName, getDynamic, getIndenter, getItem, getItemCreatePermission, getJob, getNewPronoun, getOwner, getOwnerItemGroup, getOwnerPrimaryView, getOwnerViewActions, getPeople, getPostConstructLandingPage, getProperties, getQueueItems, getSearchUrl, getTimeline, getUrl, getViewName, getViewUrl, getWidgets, hasPeople, hasPermission, isAutomaticRefreshEnabled, isDefault, isEditable, isFilterExecutors, isFilterQueue, makeSearchIndex, onJobRenamed, rename, save, toString, updateByXml, updateTransientActions, writeXml

Methods inherited from class hudson.model.AbstractModelObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchListView

@DataBoundConstructor
public BranchListView(String name)

Constructor used for loading objects of this type.

Parameters:

name - Name of view

BranchListView

public BranchListView(String name,
                      hudson.model.ViewGroup owner)

Constructor used to instantiate new views with an owner.

Parameters:

name - Name of view

owner - Owner of view

Method Detail

getBranch

public final hudson.model.TopLevelItem getBranch(String name)

Alias for View.getItem(String). This is the one used in the URL binding.

Parameters:

name - Name of branch

Returns:

View.getItem(String)

getConfigureUrl

public String getConfigureUrl()

Used by Jelly to get the correct configure URL when linking from views with no jobs.

Returns:

String - cron

doNewJob

public final void doNewJob()

Stapler URL binding

doCreateItem

public final void doCreateItem()

Stapler URL binding

registerXStream

@Initializer(before=PLUGINS_STARTED)
public static void registerXStream()

Gives this class an alias for configuration XML.