1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/main/java/de/uapcore/lightpit/Menu.java Sat May 09 14:26:31 2020 +0200
1.3 @@ -0,0 +1,97 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2018 Mike Becker. All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + *
1.31 + */
1.32 +package de.uapcore.lightpit;
1.33 +
1.34 +import java.util.ArrayList;
1.35 +import java.util.Collections;
1.36 +import java.util.List;
1.37 +
1.38 +/**
1.39 + * Maps a resource key for the menu label to the path name for the underlying
1.40 + * site.
1.41 + *
1.42 + * Objects of this class are internally instantiated by the
1.43 + * {@link ModuleManager}.
1.44 + */
1.45 +public class Menu extends MenuEntry {
1.46 +
1.47 + private final List<MenuEntry> entries = new ArrayList<>();
1.48 + private final List<MenuEntry> immutableEntries = Collections.unmodifiableList(entries);
1.49 +
1.50 + /**
1.51 + * Class name of the module for which this menu is built.
1.52 + */
1.53 + private String moduleClassName;
1.54 +
1.55 +
1.56 + public Menu() {
1.57 + super();
1.58 + }
1.59 +
1.60 + public Menu(String moduleClassName, ResourceKey resourceKey, String pathName) {
1.61 + super(resourceKey, pathName);
1.62 + this.moduleClassName = moduleClassName;
1.63 + }
1.64 +
1.65 + public void setModuleClassName(String moduleClassName) {
1.66 + this.moduleClassName = moduleClassName;
1.67 + }
1.68 +
1.69 + public String getModuleClassName() {
1.70 + return moduleClassName;
1.71 + }
1.72 +
1.73 + /**
1.74 + * Sets a new list of menu entries for this menu.
1.75 + *
1.76 + * @param entries the list of new menu entries
1.77 + */
1.78 + public void setEntries(List<MenuEntry> entries) {
1.79 + // in case the given list is immutable, we copy the contents
1.80 + this.entries.clear();
1.81 + this.entries.addAll(entries);
1.82 + }
1.83 +
1.84 + /**
1.85 + * Retrieves an immutable list of menu entries for this menu.
1.86 + *
1.87 + * @return the list of menu entries
1.88 + */
1.89 + public List<MenuEntry> getEntries() {
1.90 + return immutableEntries;
1.91 + }
1.92 +
1.93 + /**
1.94 + * Adds a new menu entry to this menu.
1.95 + * @param entry the menu entry to add
1.96 + */
1.97 + public void addMenuEntry(MenuEntry entry) {
1.98 + entries.add(entry);
1.99 + }
1.100 +}
