hudson.tasks.BuildStepDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation
Contains the core Hudson code and view files to render HTML.
The newest version!
/*******************************************************************************
 *
 * Copyright (c) 2004-2009 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * 
 *    Kohsuke Kawaguchi
 *
 *
 *******************************************************************************/ 

package hudson.tasks;

import hudson.model.Describable;
import hudson.model.Descriptor;
import hudson.model.AbstractProject;
import hudson.model.Hudson;
import hudson.model.AbstractProject.AbstractProjectDescriptor;

import java.util.List;
import java.util.ArrayList;

/**
 * {@link Descriptor} for {@link Builder} and {@link Publisher}.
 *
 *  For compatibility reasons, plugins developed before 1.150 may not extend
 * from this descriptor type.
 *
 * @author Kohsuke Kawaguchi
 * @since 1.150
 */
public abstract class BuildStepDescriptor> extends Descriptor {

    protected BuildStepDescriptor(Class clazz) {
        super(clazz);
    }

    /**
     * Infers the type of the corresponding {@link BuildStep} from the outer
     * class. This version works when you follow the common convention, where a
     * descriptor is written as the static nested class of the describable
     * class.
     *
     * @since 1.278
     */
    protected BuildStepDescriptor() {
    }

    /**
     * Returns true if this task is applicable to the given project.
     *
     * @return true to allow user to configure this post-promotion task for the
     * given project.
     * @see AbstractProjectDescriptor#isApplicable(Descriptor)
     */
    public abstract boolean isApplicable(Class jobType);

    /**
     * Filters a descriptor for {@link BuildStep}s by using
     * {@link BuildStepDescriptor#isApplicable(Class)}.
     */
    public static > List> filter(List> base, Class type) {
        // descriptor of the project
        Descriptor pd = Hudson.getInstance().getDescriptor((Class) type);

        List> r = new ArrayList>(base.size());
        for (Descriptor d : base) {
            if (pd instanceof AbstractProjectDescriptor && !((AbstractProjectDescriptor) pd).isApplicable(d)) {
                continue;
            }

            if (d instanceof BuildStepDescriptor) {
                BuildStepDescriptor bd = (BuildStepDescriptor) d;
                if (!bd.isApplicable(type)) {
                    continue;
                }
                r.add(bd);
            } else {
                // old plugins built before 1.150 may not implement BuildStepDescriptor
                r.add(d);
            }
        }
        return r;
    }
}