Class AbstractFolderProperty<C extends AbstractFolder<?>>
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<AbstractFolderProperty<?>>
-
- com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<C>
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<AbstractFolderProperty<?>>
,ReconfigurableDescribable<AbstractFolderProperty<?>>
- Direct Known Subclasses:
FolderCredentialsProvider.FolderCredentialsProperty
,FolderProperty
public abstract class AbstractFolderProperty<C extends AbstractFolder<?>> extends AbstractDescribableImpl<AbstractFolderProperty<?>> implements ExtensionPoint, ReconfigurableDescribable<AbstractFolderProperty<?>>
Property potentially applicable to anyAbstractFolder
.- Since:
- 4.11-beta-1
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
Fields Modifier and Type Field Description protected C
owner
TheAbstractFolder
object that owns this property.
-
Constructor Summary
Constructors Constructor Description AbstractFolderProperty()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AbstractFolderPropertyDescriptor
getDescriptor()
List<FolderHealthMetric>
getHealthMetrics()
Returns the health metrics contributed by this property.List<HealthReport>
getHealthReports()
Folder properties can optionally contribute health reports for the folder.Collection<?>
getItemContainerOverrides()
Provides stapler override objects toFolder
so that its URL space can be partially overridden by properties.C
getOwner()
Gets an owner of the property.AbstractFolderProperty<?>
reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form)
protected void
setOwner(C owner)
Hook for performing post-initialization action.
-
-
-
Field Detail
-
owner
protected transient C extends AbstractFolder<?> owner
TheAbstractFolder
object that owns this property. This value will be set by the folder. Derived classes can expect this value to be always set.
-
-
Method Detail
-
setOwner
protected void setOwner(@NonNull C owner)
Hook for performing post-initialization action.- Parameters:
owner
- the owner.
-
getOwner
@NonNull @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public C getOwner()
Gets an owner of the property.- Returns:
- Owner of the property. It should be always non-null if the property initialized correctly.
-
getDescriptor
public AbstractFolderPropertyDescriptor getDescriptor()
- Specified by:
getDescriptor
in interfaceDescribable<C extends AbstractFolder<?>>
- Overrides:
getDescriptor
in classAbstractDescribableImpl<AbstractFolderProperty<?>>
-
getItemContainerOverrides
public Collection<?> getItemContainerOverrides()
Provides stapler override objects toFolder
so that its URL space can be partially overridden by properties.- Returns:
- the overrides.
- See Also:
StaplerOverridable
-
reconfigure
public AbstractFolderProperty<?> reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form) throws Descriptor.FormException
- Specified by:
reconfigure
in interfaceReconfigurableDescribable<C extends AbstractFolder<?>>
- Throws:
Descriptor.FormException
-
getHealthReports
@NonNull public List<HealthReport> getHealthReports()
Folder properties can optionally contribute health reports for the folder. These should be reports of the folder directly, where a report requires iteration of the items in the folder use thegetHealthMetrics()
in order to prevent multiple iterations of the items in the folder.- Returns:
- the list of health reports.
-
getHealthMetrics
@NonNull public List<FolderHealthMetric> getHealthMetrics()
Returns the health metrics contributed by this property.- Returns:
- the health metrics contributed by this property.
-
-