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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
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;
25
26 import hudson.scm.PollingResult;
27 import hudson.scm.SCM;
28 import hudson.triggers.SCMTrigger;
29
30 /**
31 * {@link Item}s that has associated SCM.
32 *
33 * @author Kohsuke Kawaguchi
34 * @see SCMTrigger
35 */
36 public interface SCMedItem extends BuildableItem {
37 /**
38 * Gets the {@link SCM} for this item.
39 *
40 * @return
41 * may return null for indicating "no SCM".
42 */
43 SCM getScm();
44
45 /**
46 * {@link SCMedItem} needs to be an instance of
47 * {@link AbstractProject}.
48 *
49 * <p>
50 * This method must be always implemented as {@code (AbstractProject)this}, but
51 * defining this method emphasizes the fact that this cast must be doable.
52 */
53 AbstractProject<?,?> asProject();
54
55 /**
56 * Checks if there's any update in SCM, and returns true if any is found.
57 *
58 * @deprecated as of 1.346
59 * Use {@link #poll(TaskListener)} instead.
60 */
61 boolean pollSCMChanges( TaskListener listener );
62
63 /**
64 * Checks if there's any update in SCM, and returns true if any is found.
65 *
66 * <p>
67 * The implementation is responsible for ensuring mutual exclusion between polling and builds
68 * if necessary.
69 *
70 * @return never null.
71 *
72 * @since 1.345
73 */
74 PollingResult poll(TaskListener listener);
75 }
76