src/main/java/de/uapcore/lightpit/Menu.java

changeset 36
0f4f8f255c32
parent 35
4fa33bfa8fb9
child 37
fecda0f466e6
equal deleted inserted replaced
35:4fa33bfa8fb9 36:0f4f8f255c32
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2018 Mike Becker. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 */
29 package de.uapcore.lightpit;
30
31 import java.util.ArrayList;
32 import java.util.Collections;
33 import java.util.List;
34
35 /**
36 * Maps a resource key for the menu label to the path name for the underlying
37 * site.
38 * <p>
39 * Objects of this class are internally instantiated by the
40 * {@link ModuleManager}.
41 */
42 public class Menu extends MenuEntry {
43
44 private final List<MenuEntry> entries = new ArrayList<>();
45 private final List<MenuEntry> immutableEntries = Collections.unmodifiableList(entries);
46
47 /**
48 * Class name of the module for which this menu is built.
49 */
50 private String moduleClassName;
51
52
53 public Menu() {
54 super();
55 }
56
57 public Menu(String moduleClassName, ResourceKey resourceKey, String pathName) {
58 super(resourceKey, pathName);
59 this.moduleClassName = moduleClassName;
60 }
61
62 public void setModuleClassName(String moduleClassName) {
63 this.moduleClassName = moduleClassName;
64 }
65
66 public String getModuleClassName() {
67 return moduleClassName;
68 }
69
70 /**
71 * Sets a new list of menu entries for this menu.
72 *
73 * @param entries the list of new menu entries
74 */
75 public void setEntries(List<MenuEntry> entries) {
76 // in case the given list is immutable, we copy the contents
77 this.entries.clear();
78 this.entries.addAll(entries);
79 }
80
81 /**
82 * Retrieves an immutable list of menu entries for this menu.
83 *
84 * @return the list of menu entries
85 */
86 public List<MenuEntry> getEntries() {
87 return immutableEntries;
88 }
89
90 /**
91 * Adds a new menu entry to this menu.
92 *
93 * @param entry the menu entry to add
94 */
95 public void addMenuEntry(MenuEntry entry) {
96 entries.add(entry);
97 }
98 }

mercurial