Package 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<TopLevelItem>

com.cloudbees.hudson.plugins.folder.Folder

All Implemented Interfaces:

ExtensionPoint, Describable<TopLevelItem>, DescriptorByNameOwner, Item, ItemGroup<TopLevelItem>, ModelObject, ModifiableItemGroup<TopLevelItem>, ModifiableViewGroup, PersistenceRoot, Saveable, TopLevelItem, ViewGroup, SearchableModelObject, SearchItem, AccessControlled, DirectlyModifiableTopLevelItemGroup, Loadable, ModelObjectWithChildren, ModelObjectWithContextMenu, ModifiableTopLevelItemGroup, OnMaster, IconSpec, org.kohsuke.stapler.HttpDeletable, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerOverridable, org.kohsuke.stapler.StaplerProxy

public class Folder
extends AbstractFolder<TopLevelItem>
implements DirectlyModifiableTopLevelItemGroup

A mutable folder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Folder.DeprecatedTransientActions	Deprecated.
static class	Folder.DescriptorImpl

Nested classes/interfaces inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolder

AbstractFolder.ItemListenerImpl, AbstractFolder.RunListenerImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface org.kohsuke.stapler.HttpDeletable

org.kohsuke.stapler.HttpDeletable.HttpDeletableDispatcher

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

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields

Modifier and Type	Field	Description
static final AlternativeUiTextProvider.Message<Folder>	NEW_PRONOUN
protected List<Action>	transientActions	Deprecated. Use TransientActionFactory instead.

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

items, reloadingThis

Fields inherited from class hudson.model.AbstractItem

description, displayName, name, PRONOUN, SKIP_PERMISSION_CHECK, TASK_NOUN

Fields inherited from interface hudson.model.Item

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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
Folder(ItemGroup parent, String name)

Method Summary

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

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

addLoadedChild, addProperty, addView, canDelete, checkRename, deleteView, doChildrenContextMenu, doChildrenContextMenu, doConfigSubmit, doCreateView, doCreateView, doDisable, doEnable, doLastBuild, doLastBuild, doSubmitDescription, doSubmitDescription, doViewExistsCheck, getAllJobs, getBuildHealth, getBuildHealthReports, getFolderViews, getHealthMetrics, getIcon, getIconClassName, getIconColor, getItem, getItemGroup, getItemName, getItems, getItems, getJob, getJobsDir, getOverrides, getPrimaryView, getPronoun, getProperties, getRootDirFor, getRootDirFor, getStaplerFallback, getSuccessfulDestination, getUrlChildPrefix, getView, getViewActions, getViews, getViewsTabBar, hasVisibleItems, invalidateBuildHealthReports, isDisabled, isNameEditable, itemsPut, loadChildren, loadJobTotal, makeDisabled, makeSearchIndex, newDefaultFolderIcon, newDefaultViewsTabBar, newFolderViewHolder, onDeleted, onRenamed, onViewRenamed, reloadThis, renameBlocker, renameTo, resetFolderViews, save, setDisabled, setIcon, setPrimaryView, supportsMakeDisabled

Methods inherited from class hudson.model.AbstractItem

delete, delete, delete, doCheckNewName, doConfigDotXml, doConfigDotXml, doConfirmRename, doDoDelete, doDoDelete, doReload, doSetName, getAbsoluteUrl, getACL, getApi, getConfigFile, getDescription, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getTarget, getTaskNoun, getUrl, load, movedTo, performDelete, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml, writeReplace

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, getDynamic, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, 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.security.AccessControlled

checkAnyPermission, checkPermission, getACL, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface hudson.model.Item

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

Methods inherited from interface hudson.model.ItemGroup

allItems, allItems, allItems, getAllItems, getAllItems, getAllItems, getFullDisplayName, getFullName, getItem, getItemName, getItems, getItems, getItemsStream, getItemsStream, getRootDirFor, getUrl, getUrlChildPrefix, onDeleted, onRenamed

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

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

getAllViews, getUrl

Field Details

NEW_PRONOUN

public static final AlternativeUiTextProvider.Message<Folder> NEW_PRONOUN

Since:

4.0

See Also:

• getNewPronoun()

transientActions

@CopyOnWrite
@Deprecated
protected transient volatile List<Action> transientActions

Deprecated.

Use TransientActionFactory instead.

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 Details

Folder

public Folder(ItemGroup parent,
 String name)

Method Details

onLoad

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

Description copied from class: AbstractFolder

Specified by:

onLoad in interface Item

Overrides:

onLoad in class AbstractFolder<TopLevelItem>

Throws:

IOException

init

protected final void init()

Overrides:

init in class AbstractFolder<TopLevelItem>

initViews

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

Overrides:

initViews in class AbstractFolder<TopLevelItem>

Throws:

IOException

onCreatedFromScratch

public void onCreatedFromScratch()

Specified by:

onCreatedFromScratch in interface Item

updateTransientActions

@Deprecated
protected void updateTransientActions()

Deprecated.

Use TransientActionFactory instead.

createTransientActions

@Deprecated
protected List<Action> createTransientActions()

Deprecated.

getNewPronoun

public String getNewPronoun()

Used in "New Job" side menu.

Returns:

the pronoun for new item creation.

See Also:

• NEW_PRONOUN

getColumns

@Deprecated
public DescribableList<ListViewColumn,Descriptor<ListViewColumn>> getColumns()

Deprecated.

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

Returns:

the columns.

addProperty

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

Deprecated.

use AbstractFolder.addProperty(AbstractFolderProperty) instead

Legacy binary compatibility method.

Parameters:

p - the property.

Throws:

IOException - if the folder could not be saved.

onCopiedFrom

public void onCopiedFrom(Item _src)

If copied, copy folder contents.

Specified by:

onCopiedFrom in interface Item

Overrides:

onCopiedFrom in class AbstractItem

doCreateItem

@POST
public TopLevelItem doCreateItem(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                          throws IOException,
jakarta.servlet.ServletException

Specified by:

doCreateItem in interface ModifiableItemGroup<TopLevelItem>

Throws:

IOException

jakarta.servlet.ServletException

doCreateItem

@Deprecated
@StaplerNotDispatchable
public TopLevelItem doCreateItem(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
                          throws IOException,
javax.servlet.ServletException

Deprecated.

use doCreateItem(StaplerRequest2, StaplerResponse2)

Specified by:

doCreateItem in interface ModifiableItemGroup<TopLevelItem>

Throws:

IOException

javax.servlet.ServletException

copy

public <T extends 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 ModifiableTopLevelItemGroup

Throws:

IOException

createProjectFromXML

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

Specified by:

createProjectFromXML in interface ModifiableTopLevelItemGroup

Throws:

IOException

createProject

public <T extends TopLevelItem> T createProject(@NonNull
 Class<T> type,
 @NonNull
 String name)
                                         throws IOException

Throws:

IOException

createProject

public TopLevelItem createProject(@NonNull
 TopLevelItemDescriptor type,
 @NonNull
 String name)
                           throws IOException

Throws:

IOException

createProject

public TopLevelItem createProject(@NonNull
 TopLevelItemDescriptor type,
 @NonNull
 String name,
 boolean notify)
                           throws IOException

Specified by:

createProject in interface ModifiableTopLevelItemGroup

Throws:

IOException

submit

protected void submit(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
               throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Overrides:

submit in class AbstractFolder<TopLevelItem>

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException

submit

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

Deprecated.

use submit(StaplerRequest2, StaplerResponse2)

Overrides:

submit in class AbstractFolder<TopLevelItem>

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException

getItemDescriptors

public List<TopLevelItemDescriptor> getItemDescriptors()

Items that can be created in this Folder.

Returns:

the descriptors of items that can be created within this folder.

See Also:

• FolderAddFilter

isAllowedChildDescriptor

public boolean isAllowedChildDescriptor(TopLevelItemDescriptor tid)

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

Parameters:

tid - the type of child item.

Returns:

true if it can be added.

isAllowedChild

public boolean isAllowedChild(TopLevelItem tid)

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

Parameters:

tid - the potential child item.

Returns:

true if it can be added.

getDescriptor

public Folder.DescriptorImpl getDescriptor()

Description copied from class: AbstractFolder

Specified by:

getDescriptor in interface Describable<TopLevelItem>

Specified by:

getDescriptor in interface TopLevelItem

Overrides:

getDescriptor in class AbstractFolder<TopLevelItem>

canAdd

public boolean canAdd(TopLevelItem item)

Specified by:

canAdd in interface DirectlyModifiableTopLevelItemGroup

add

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

Specified by:

add in interface DirectlyModifiableTopLevelItemGroup

Throws:

IOException

IllegalArgumentException

remove

public void remove(TopLevelItem item)
            throws IOException,
IllegalArgumentException

Specified by:

remove in interface DirectlyModifiableTopLevelItemGroup

Throws:

IOException

IllegalArgumentException