File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\queue\FoldableAction.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.model.queue;
25
26 import hudson.model.Queue.Task;
27 import hudson.model.Action;
28 import hudson.model.Queue;
29
30 import java.util.List;
31
32 /**
33 * An action interface that allows action data to be folded together.
34 *
35 * <p>
36 * {@link Action} can implement this optional marker interface to be notified when
37 * the {@link Task} that it's added to the queue with is determined to be "already in the queue".
38 *
39 * <p>
40 * This is useful for passing on parameters to the task that's already in the queue.
41 *
42 * @author mdonohue
43 * @since 1.300-ish.
44 */
45 public interface FoldableAction extends Action {
46 /**
47 * Notifies that the {@link Task} that "owns" this action (that is, the task for which this action is submitted)
48 * is considered as a duplicate.
49 *
50 * @param item
51 * The existing {@link Queue.Item} in the queue against which we are judged as a duplicate. Never null.
52 * @param owner
53 * The {@link Task} with which this action was submitted to the queue. Never null.
54 * @param otherActions
55 * Other {@link Action}s that are submitted with the task. (One of them is this {@link FoldableAction}.)
56 * Never null.
57 */
58 void foldIntoExisting(Queue.Item item, Task owner, List<Action> otherActions);
59 }
60