Class InheritanceListActionFactory

  • All Implemented Interfaces:
    ExtensionPoint

    @Extension
    public final class InheritanceListActionFactory
    extends TransientProjectActionFactory
    Jenkins extension for creating actions that will be used for displaying the inheritance diagram of jobs of type inheritance project.

    One instance of this class will be created by automatically created by the Jenkins server at start up time. The Jenkins server will then call the createFor(AbstractProject) method for each existing job. That method will return one single InheritanceListAction instance. Jenkins will then add it as a transient action to the given project.

    • Constructor Detail

      • InheritanceListActionFactory

        public InheritanceListActionFactory()
    • Method Detail

      • createFor

        public Collection<? extends Action> createFor​(AbstractProject target)
        Creates and returns one single InheritanceListAction that will be added to the given job.

        The returned InheritanceListAction will be added by Jenkins to the given job as a transient action. Transient actions are not persisted.

        The purpose of the returned InheritanceListAction is to add a section to the job detail page with an inheritance diagram in case the job is of type inheritance project.

        This method is automatically called by Jenkins during the initialisation of a job object.

        Specified by:
        createFor in class TransientProjectActionFactory
        Parameters:
        target - The job for which we are to create our action.
        Returns:
        A collection with one single InheritanceListAction instance.