hudson.model.ResourceActivity 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.model;

/**
 * Activity that requires certain resources for its execution.
 *
 * @author Kohsuke Kawaguchi
 */
public interface ResourceActivity {

    /**
     * Gets the list of {@link Resource}s that this task requires. Used to make
     * sure no two conflicting tasks run concurrently.
     *
     *  This method must always return the {@link ResourceList} that contains
     * the exact same set of {@link Resource}s.
     *
     *  If the activity doesn't lock any resources, just return
     * {@code new ResourceList()}.
     *
     * @return never null
     */
    ResourceList getResourceList();

    /**
     * Used for rendering HTML.
     */
    String getDisplayName();
}