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