File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\triggers\TriggerDescriptor.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.triggers;
25
26 import hudson.model.Descriptor;
27 import hudson.model.Item;
28 import hudson.scm.SCM;
29
30 /**
31 * {@link Descriptor} for Trigger.
32 * @author Kohsuke Kawaguchi
33 */
34 public abstract class TriggerDescriptor extends Descriptor<Trigger<?>> {
35 protected TriggerDescriptor(Class<? extends Trigger<?>> clazz) {
36 super(clazz);
37 }
38
39 /**
40 * Infers the type of the corresponding {@link SCM} from the outer class.
41 * This version works when you follow the common convention, where a descriptor
42 * is written as the static nested class of the describable class.
43 *
44 * @since 1.278
45 */
46 protected TriggerDescriptor() {
47 }
48
49 /**
50 * Returns true if this trigger is applicable to the
51 * given {@link Item}.
52 *
53 * @return
54 * true to allow user to configure a trigger for this item.
55 */
56 public abstract boolean isApplicable(Item item);
57 }
58