hudson.model.Actionable 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, Stephen Connolly
 *
 *
 *******************************************************************************/ 

package hudson.model;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;

import java.util.List;
import java.util.Vector;
import java.util.concurrent.CopyOnWriteArrayList;

/**
 * {@link ModelObject} that can have additional {@link Action}s.
 *
 * @author Kohsuke Kawaguchi
 */
@ExportedBean
public abstract class Actionable extends AbstractModelObject {

    /**
     * Actions contributed to this model object.
     *
     * Typed more strongly than it should to improve the serialization
     * signature.
     */
    private volatile CopyOnWriteArrayList actions;

    /**
     * Gets actions contributed to this build.
     *
     *  A new {@link Action} can be added by {@code getActions().add(...)}.
     *
     * @return may be empty but never null.
     */
    @Exported
    public synchronized List getActions() {
        if (actions == null) {
            actions = new CopyOnWriteArrayList();
        }
        return actions;
    }

    /**
     * Gets all actions of a specified type that contributed to this build.
     *
     * @param type The type of action to return.
     * @return may be empty but never null.
     * @see #getAction(Class)
     */
    public  List getActions(Class type) {
        List result = new Vector();
        for (Action a : getActions()) {
            if (type.isInstance(a)) {
                result.add(type.cast(a));
            }
        }
        return result;
    }

    /**
     * Adds a new action.
     *
     * Short for getActions().add(a)
     */
    public void addAction(Action a) {
        if (a == null) {
            throw new IllegalArgumentException();
        }
        getActions().add(a);
    }

    public Action getAction(int index) {
        if (actions == null) {
            return null;
        }
        return actions.get(index);
    }

    /**
     * Gets the action (first instance to be found) of a specified type that
     * contributed to this build.
     *
     * @param type
     * @return The action or null if no such actions exist.
     * @see #getActions(Class)
     */
    public  T getAction(Class type) {
        for (Action a : getActions()) {
            if (type.isInstance(a)) {
                return type.cast(a);
            }
        }
        return null;
    }

    public Object getDynamic(String token, StaplerRequest req, StaplerResponse rsp) {
        for (Action a : getActions()) {
            if (a == null) {
                continue;   // be defensive
            }
            String urlName = a.getUrlName();
            if (urlName == null) {
                continue;
            }
            if (urlName.equals(token)) {
                return a;
            }
        }
        return null;
    }
}