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

Sun, 17 Dec 2017 01:45:28 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 17 Dec 2017 01:45:28 +0100
changeset 11
737ab27e37b3
parent 10
89e3e6e28b69
child 24
8137ec335416
permissions
-rw-r--r--

implements simple request mapper

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

mercurial