com.cloudbees.hudson.plugins.folder

Class Folder

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.AbstractItem

com.cloudbees.hudson.plugins.folder.AbstractFolder<hudson.model.TopLevelItem>

com.cloudbees.hudson.plugins.folder.Folder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.TopLevelItem>, hudson.model.DescriptorByNameOwner, hudson.model.Item, hudson.model.ItemGroup<hudson.model.TopLevelItem>, hudson.model.ModelObject, hudson.model.ModifiableItemGroup<hudson.model.TopLevelItem>, hudson.model.ModifiableViewGroup, hudson.model.PersistenceRoot, hudson.model.Saveable, hudson.model.TopLevelItem, hudson.model.ViewGroup, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.DirectlyModifiableTopLevelItemGroup, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, jenkins.model.ModifiableTopLevelItemGroup, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerOverridable

public class Folder
extends AbstractFolder<hudson.model.TopLevelItem>
implements jenkins.model.DirectlyModifiableTopLevelItemGroup

A mutable folder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Folder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.util.AlternativeUiTextProvider.Message<Folder>	NEW_PRONOUN
protected List<hudson.model.Action>	transientActions Actions contributed from subsidiary objects associated with Folder, such as from properties.

Fields inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolder

items

Fields inherited from class hudson.model.AbstractItem

description, displayName, name, PRONOUN

Fields inherited from interface hudson.model.Saveable

NOOP

Fields inherited from interface hudson.model.Item

BUILD, CANCEL, CONFIGURE, CREATE, DELETE, DISCOVER, EXTENDED_READ, PERMISSIONS, READ, WIPEOUT, WORKSPACE

Constructor Summary

Constructors

Constructor and Description
Folder(hudson.model.ItemGroup parent, String name)

Method Summary

Modifier and Type	Method and Description
<I extends hudson.model.TopLevelItem> I	add(I item, String name)
void	addProperty(FolderProperty<?> p) Deprecated. use AbstractFolder.addProperty(AbstractFolderProperty) instead
boolean	canAdd(hudson.model.TopLevelItem item)
<T extends hudson.model.TopLevelItem> T	copy(T src, String name) Copies an existing TopLevelItem to into this folder with a new name.
<T extends hudson.model.TopLevelItem> T	createProject(Class<T> type, String name)
hudson.model.TopLevelItem	createProject(hudson.model.TopLevelItemDescriptor type, String name)
hudson.model.TopLevelItem	createProject(hudson.model.TopLevelItemDescriptor type, String name, boolean notify)
hudson.model.TopLevelItem	createProjectFromXML(String name, InputStream xml)
protected List<hudson.model.Action>	createTransientActions()
hudson.util.FormValidation	doCheckJobName(String value)
hudson.model.TopLevelItem	doCreateItem(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
List<hudson.model.Action>	getActions()
hudson.util.DescribableList<hudson.views.ListViewColumn,hudson.model.Descriptor<hudson.views.ListViewColumn>>	getColumns() Deprecated. as of 1.7 Folder is no longer a view by itself.
Folder.DescriptorImpl	getDescriptor()
List<hudson.model.TopLevelItemDescriptor>	getItemDescriptors() Items that can be created in this Folder.
String	getNewPronoun() Used in "New Job" side menu.
protected void	init()
protected void	initViews(List<hudson.model.View> views)
boolean	isAllowedChild(hudson.model.TopLevelItem tid) Historical synonym for canAdd(hudson.model.TopLevelItem).
boolean	isAllowedChildDescriptor(hudson.model.TopLevelItemDescriptor tid) Returns true if the specified descriptor type is allowed for this container.
void	onCopiedFrom(hudson.model.Item _src) If copied, copy folder contents.
void	onCreatedFromScratch()
void	onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent, String name)
void	remove(hudson.model.TopLevelItem item)
protected void	submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
protected void	updateTransientActions() effectively deprecated.

Methods inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolder

addProperty, addView, canDelete, deleteView, doChildrenContextMenu, doConfigSubmit, doCreateView, doDoRename, doLastBuild, doSubmitDescription, doViewExistsCheck, getAllJobs, getBuildHealth, getBuildHealthReports, getHealthMetrics, getIcon, getIconColor, getItem, getItemGroup, getItems, getJob, getJobsDir, getOverrides, getPrimaryView, getPronoun, getProperties, getRootDirFor, getRootDirFor, getStaplerFallback, getUrlChildPrefix, getView, getViewActions, getViews, getViewsTabBar, loadJobTotal, makeSearchIndex, onDeleted, onRenamed, onViewRenamed, performDelete, renameBlocker, renameTo, save, setIcon, setPrimaryView

Methods inherited from class hudson.model.AbstractItem

checkPermission, delete, delete, doConfigDotXml, doDoDelete, doReload, doSetName, getAbsoluteUrl, getACL, getApi, getConfigFile, getDescription, getDescriptorByName, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFrom, getRelativeNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getUrl, hasPermission, movedTo, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml

Methods inherited from class hudson.model.Actionable

addAction, doContextMenu, getAction, getAction, getActions, getAllActions, getDynamic, replaceAction

Methods inherited from class hudson.model.AbstractModelObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.ItemGroup

getFullDisplayName, getFullName, getItem, getItems, getRootDirFor, getUrl, getUrlChildPrefix, onDeleted, onRenamed

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.model.Saveable

save

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex, getSearchName, getSearchUrl

Methods inherited from interface hudson.model.ViewGroup

getUrl

Methods inherited from interface hudson.security.AccessControlled

checkPermission, getACL, hasPermission

Field Detail

NEW_PRONOUN

public static final hudson.util.AlternativeUiTextProvider.Message<Folder> NEW_PRONOUN

Since:

4.0

See Also:

getNewPronoun()

transientActions

@CopyOnWrite
protected transient volatile List<hudson.model.Action> transientActions

Actions contributed from subsidiary objects associated with Folder, such as from properties.

We don't want to persist them separately, and these actions come and go as configuration change, so it's kept separate.

Constructor Detail

Folder

public Folder(hudson.model.ItemGroup parent,
              String name)

Method Detail

onLoad

public void onLoad(hudson.model.ItemGroup<? extends hudson.model.Item> parent,
                   String name)
            throws IOException

Specified by:

onLoad in interface hudson.model.Item

Overrides:

onLoad in class AbstractFolder<hudson.model.TopLevelItem>

Throws:

IOException

init

protected final void init()

Overrides:

init in class AbstractFolder<hudson.model.TopLevelItem>

initViews

protected void initViews(List<hudson.model.View> views)
                  throws IOException

Overrides:

initViews in class AbstractFolder<hudson.model.TopLevelItem>

Throws:

IOException

onCreatedFromScratch

public void onCreatedFromScratch()

Specified by:

onCreatedFromScratch in interface hudson.model.Item

Overrides:

onCreatedFromScratch in class hudson.model.AbstractItem

getActions

public List<hudson.model.Action> getActions()

Note that this method returns a read-only view of Actions.

Overrides:

getActions in class hudson.model.Actionable

See Also:

TransientFolderActionFactory, FolderProperty.getFolderActions()

updateTransientActions

protected void updateTransientActions()

effectively deprecated. Since using updateTransientActions correctly under concurrent environment requires a lock that can too easily cause deadlocks.

createTransientActions

protected List<hudson.model.Action> createTransientActions()

getNewPronoun

public String getNewPronoun()

Used in "New Job" side menu.

See Also:

NEW_PRONOUN

getColumns

public hudson.util.DescribableList<hudson.views.ListViewColumn,hudson.model.Descriptor<hudson.views.ListViewColumn>> getColumns()

Deprecated. as of 1.7 Folder is no longer a view by itself.

addProperty

@Deprecated
public void addProperty(FolderProperty<?> p)
                             throws IOException

Deprecated. use AbstractFolder.addProperty(AbstractFolderProperty) instead

Throws:

IOException

onCopiedFrom

public void onCopiedFrom(hudson.model.Item _src)

If copied, copy folder contents.

Specified by:

onCopiedFrom in interface hudson.model.Item

Overrides:

onCopiedFrom in class hudson.model.AbstractItem

doCreateItem

public hudson.model.TopLevelItem doCreateItem(org.kohsuke.stapler.StaplerRequest req,
                                              org.kohsuke.stapler.StaplerResponse rsp)
                                       throws IOException,
                                              javax.servlet.ServletException

Specified by:

doCreateItem in interface hudson.model.ModifiableItemGroup<hudson.model.TopLevelItem>

Throws:

IOException

javax.servlet.ServletException

doCheckJobName

public hudson.util.FormValidation doCheckJobName(@QueryParameter
                                                 String value)

copy

public <T extends hudson.model.TopLevelItem> T copy(T src,
                                                    String name)
                                             throws IOException

Copies an existing TopLevelItem to into this folder with a new name.

Specified by:

copy in interface jenkins.model.ModifiableTopLevelItemGroup

Throws:

IOException

createProjectFromXML

public hudson.model.TopLevelItem createProjectFromXML(String name,
                                                      InputStream xml)
                                               throws IOException

Specified by:

createProjectFromXML in interface jenkins.model.ModifiableTopLevelItemGroup

Throws:

IOException

createProject

public <T extends hudson.model.TopLevelItem> T createProject(Class<T> type,
                                                             String name)
                                                      throws IOException

Throws:

IOException

createProject

public hudson.model.TopLevelItem createProject(hudson.model.TopLevelItemDescriptor type,
                                               String name)
                                        throws IOException

Throws:

IOException

createProject

public hudson.model.TopLevelItem createProject(hudson.model.TopLevelItemDescriptor type,
                                               String name,
                                               boolean notify)
                                        throws IOException

Specified by:

createProject in interface jenkins.model.ModifiableTopLevelItemGroup

Throws:

IOException

submit

protected void submit(org.kohsuke.stapler.StaplerRequest req,
                      org.kohsuke.stapler.StaplerResponse rsp)
               throws IOException,
                      javax.servlet.ServletException,
                      hudson.model.Descriptor.FormException

Overrides:

submit in class AbstractFolder<hudson.model.TopLevelItem>

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

getItemDescriptors

public List<hudson.model.TopLevelItemDescriptor> getItemDescriptors()

Items that can be created in this Folder.

See Also:

FolderAddFilter

isAllowedChildDescriptor

public boolean isAllowedChildDescriptor(hudson.model.TopLevelItemDescriptor tid)

Returns true if the specified descriptor type is allowed for this container.

isAllowedChild

public boolean isAllowedChild(hudson.model.TopLevelItem tid)

Historical synonym for canAdd(hudson.model.TopLevelItem).

getDescriptor

public Folder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.TopLevelItem>

Specified by:

getDescriptor in interface hudson.model.TopLevelItem

Overrides:

getDescriptor in class AbstractFolder<hudson.model.TopLevelItem>

canAdd

public boolean canAdd(hudson.model.TopLevelItem item)

Specified by:

canAdd in interface jenkins.model.DirectlyModifiableTopLevelItemGroup

add

public <I extends hudson.model.TopLevelItem> I add(I item,
                                                   String name)
                                            throws IOException,
                                                   IllegalArgumentException

Specified by:

add in interface jenkins.model.DirectlyModifiableTopLevelItemGroup

Throws:

IOException

IllegalArgumentException

remove

public void remove(hudson.model.TopLevelItem item)
            throws IOException,
                   IllegalArgumentException

Specified by:

remove in interface jenkins.model.DirectlyModifiableTopLevelItemGroup

Throws:

IOException

IllegalArgumentException