Package com.cloudbees.jenkins.support.impl

Class DirectoryComponent<T extends AbstractModelObject>

java.lang.Object

com.cloudbees.jenkins.support.api.Component

com.cloudbees.jenkins.support.api.ObjectComponent<T>

com.cloudbees.jenkins.support.impl.DirectoryComponent<T>

All Implemented Interfaces:

ExtensionPoint, Describable<ObjectComponent<T>>

Direct Known Subclasses:

AbstractItemDirectoryComponent, NodeRemoteDirectoryComponent, RunDirectoryComponent

public abstract class DirectoryComponent<T extends AbstractModelObject>
extends ObjectComponent<T>
implements ExtensionPoint

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DirectoryComponent.DirectoryComponentsDescriptor<T extends AbstractModelObject>
static class	DirectoryComponent.DirGlobScanner

Nested classes/interfaces inherited from class com.cloudbees.jenkins.support.api.Component

Component.ComponentCategory

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
DirectoryComponent()
DirectoryComponent(String includes, String excludes, boolean defaultExcludes, int maxDepth)

Method Summary

Modifier and Type	Method	Description
boolean	getDefaultExcludes()
DirectoryComponent.DirectoryComponentsDescriptor<T>	getDescriptor()
String	getDisplayName()
String	getExcludes()
String	getIncludes()
int	getMaxDepth()
Set<Permission>	getRequiredPermissions()	Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.
protected final void	list(File dir, FileVisitor visitor)
void	setDefaultExcludes(boolean defaultExcludes)
void	setExcludes(String excludes)
void	setIncludes(String includes)
void	setMaxDepth(int maxDepth)

Methods inherited from class com.cloudbees.jenkins.support.api.ObjectComponent

addContents, addContents, allInstances, for_, isApplicable, isApplicable, isSelectedByDefault

Methods inherited from class com.cloudbees.jenkins.support.api.Component

canBeGeneratedAsync, getCategory, getDisplayPermissions, getId, isEnabled, isSelectedByDefault, start, supersedes

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryComponent

public DirectoryComponent()

DirectoryComponent

public DirectoryComponent(String includes,
 String excludes,
 boolean defaultExcludes,
 int maxDepth)

Method Details

list

protected final void list(File dir,
 FileVisitor visitor)
                   throws IOException

Throws:

IOException

getIncludes

public String getIncludes()

getExcludes

public String getExcludes()

getDefaultExcludes

public boolean getDefaultExcludes()

getMaxDepth

public int getMaxDepth()

setIncludes

public void setIncludes(String includes)

setExcludes

public void setExcludes(String excludes)

setDefaultExcludes

public void setDefaultExcludes(boolean defaultExcludes)

setMaxDepth

public void setMaxDepth(int maxDepth)

getDescriptor

public DirectoryComponent.DirectoryComponentsDescriptor<T> getDescriptor()

Description copied from class: ObjectComponent

Specified by:

getDescriptor in interface Describable<T extends AbstractModelObject>

Overrides:

getDescriptor in class ObjectComponent<T extends AbstractModelObject>

getRequiredPermissions

@NonNull
public Set<Permission> getRequiredPermissions()

Description copied from class: Component

Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle. An empty list indicates that any user can include this bundle.

Specified by:

getRequiredPermissions in class Component

Returns:

the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in class Component