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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2012, Vincent Latombe.
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.Extension;
27 import hudson.ExtensionList;
28 import hudson.ExtensionPoint;
29 import jenkins.model.Jenkins;
30 import java.util.Collection;
31 import java.util.Collections;
32
33 /**
34 * Extension point for inserting transient {@link Action}s into {@link User}s.
35 *
36 * To register your implementation, put {@link Extension} on your subtype.
37 *
38 * @author Vincent Latombe
39 * @since 1.477
40 * @see Action
41 */
42
43 public abstract class TransientUserActionFactory implements ExtensionPoint {
44 /**
45 * Creates actions for the given user.
46 *
47 * @param target for which the action objects are requested. Never null.
48 * @return Can be empty but must not be null.
49 */
50 public Collection<? extends Action> createFor(User target) {
51 return Collections.emptyList();
52 }
53
54 /**
55 * Returns all the registered {@link TransientUserActionFactory}s.
56 */
57 public static ExtensionList<TransientUserActionFactory> all() {
58 return Jenkins.getInstance().getExtensionList(TransientUserActionFactory.class);
59 }
60 }