BranchProperty.java

/*
 * The MIT License
 *
 * Copyright (c) 2011-2013, CloudBees, Inc., Stephen Connolly.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package jenkins.branch;

import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.ExtensionPoint;
import hudson.Util;
import hudson.model.AbstractBuild;
import hudson.model.AbstractDescribableImpl;
import hudson.model.AbstractProject;
import hudson.model.Build;
import hudson.model.Job;
import hudson.model.Project;
import hudson.model.Run;
import java.util.ArrayList;
import java.util.List;

/**
 * Additional information associated with {@link Branch}.
 * <p>
 * {@link jenkins.scm.api.SCMSource}s can use properties to convey additional implementation/SCM specific
 * information that's not captured in the base {@link Branch} class.
 *
 * @author Kohsuke Kawaguchi
 */
public abstract class BranchProperty extends AbstractDescribableImpl<BranchProperty> implements ExtensionPoint {

    /**
     * Returns a {@link ProjectDecorator} for the supplied project instance.
     *
     * @param project the project instance.
     * @return a {@link ProjectDecorator} or {@code null} if none appropriate to this type of project.
     * @deprecated Should have been typed to take {@link Project} and {@link Build} rather than
     * {@link AbstractProject} and {@link AbstractBuild}.
     */
    @CheckForNull
    @SuppressWarnings({"unchecked", "rawtypes"})
    @Deprecated
    public final ProjectDecorator decorator(AbstractProject project) {
        return decorator(project.getClass());
    }

    /**
     * Returns a {@link ProjectDecorator} for the specific project type.
     *
     * @param clazz the project class.
     * @return a {@link ProjectDecorator} or {@code null} if none appropriate to this type of project.
     * @deprecated Should have been typed to take {@link Project} and {@link Build} rather than
     * {@link AbstractProject} and {@link AbstractBuild}.
     */
    @CheckForNull
    @SuppressWarnings({"unchecked", "rawtypes"})
    @Deprecated
    public ProjectDecorator decorator(Class clazz) {
        JobDecorator d = jobDecorator(clazz);
        return d instanceof ProjectDecorator ? (ProjectDecorator) d : null;
    }

    /**
     * Returns a {@link JobDecorator} for the specific job type.
     * @param clazz the job class.
     * @param <P> the type of job.
     * @param <B> the type of run of the job.
     * @return a {@link JobDecorator} or {@code null} if none appropriate to this type of job.
     */
    @CheckForNull
    @SuppressWarnings("unchecked")
    public /*abstract*/ <P extends Job<P,B>,B extends Run<P,B>> JobDecorator<P,B> jobDecorator(Class<P> clazz) {
        if (Util.isOverridden(BranchProperty.class, getClass(), "decorator", Class.class) && AbstractProject.class.isAssignableFrom(clazz)) {
            return decorator(clazz);
        } else {
            throw new AbstractMethodError("you must implement jobDecorator in " + getClass());
        }
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    public BranchPropertyDescriptor getDescriptor() {
        return (BranchPropertyDescriptor) super.getDescriptor();
    }

    /**
     * Utility helper method that ensures you have an {@link ArrayList} but avoids copying unless required.
     * @param list the list that may or may not be an {@link ArrayList}.
     * @param <T> the type of elements in the list.
     * @return either the supplied {@link List} if it was an {@link ArrayList} or a copy of the supplied list in a
     * newly created {@link ArrayList}.
     */
    protected static <T> ArrayList<T> asArrayList(List<T> list) {
        return list instanceof ArrayList ? (ArrayList<T>)list : new ArrayList<T>(list);
    }
}