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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2011, CloudBees, 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;
25
26 import jenkins.model.Jenkins;
27
28 /**
29 * Walks the tree structure that consists of {@link ItemGroup} and {@link Item}.
30 *
31 * @author Kohsuke Kawaguchi
32 * @since 1.402
33 */
34 public abstract class ItemVisitor {
35 /**
36 * Visits an {@link ItemGroup} by visits the member items.
37 */
38 public void onItemGroup(ItemGroup<?> group) {
39 for (Item i : group.getItems())
40 if (i.hasPermission(Item.READ))
41 onItem(i);
42 }
43
44 /**
45 * Visits an {@link Item}. If it is a group,
46 * visits the children.
47 */
48 public void onItem(Item i) {
49 if(i instanceof ItemGroup)
50 onItemGroup((ItemGroup)i);
51 }
52
53 /**
54 * Visits the entire tree rooted at {@code Hudson.getInstance()}.
55 * <p>
56 * To walk a subtree, call {@link #onItemGroup(ItemGroup)} or {@link #onItem(Item)}
57 */
58 public final void walk() {
59 onItemGroup(Jenkins.getInstance());
60 }
61 }
62