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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2010, InfraDNA, 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.labels;
25
26 import hudson.DescriptorExtensionList;
27 import hudson.ExtensionPoint;
28 import hudson.model.AbstractDescribableImpl;
29 import hudson.model.Action;
30 import jenkins.model.Jenkins;
31 import org.kohsuke.stapler.export.ExportedBean;
32
33 import java.util.Collection;
34 import java.util.Collections;
35
36 /**
37 * Extensible property of {@link LabelAtom}.
38 *
39 * <p>
40 * Plugins can contribute this extension point to add additional data or UI actions to {@link LabelAtom}.
41 * {@link LabelAtomProperty}s show up in the configuration screen of a label, and they are persisted
42 * with the {@link LabelAtom} object.
43 *
44 * @author Kohsuke Kawaguchi
45 * @since 1.373
46 */
47 @ExportedBean
48 public class LabelAtomProperty extends AbstractDescribableImpl<LabelAtomProperty> implements ExtensionPoint {
49 /**
50 * Contributes {@link Action}s to the label.
51 *
52 * This allows properties to create additional links in the left navigation bar and
53 * hook into the URL space of the label atom.
54 */
55 public Collection<? extends Action> getActions(LabelAtom atom) {
56 return Collections.emptyList();
57 }
58
59 /**
60 * Lists up all the registered {@link LabelAtomPropertyDescriptor}s in the system.
61 */
62 public static DescriptorExtensionList<LabelAtomProperty,LabelAtomPropertyDescriptor> all() {
63 return Jenkins.getInstance().<LabelAtomProperty,LabelAtomPropertyDescriptor>getDescriptorList(LabelAtomProperty.class);
64 }
65 }
66