universe@10: /*
universe@10:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@10:  * 
universe@24:  * Copyright 2018 Mike Becker. All rights reserved.
universe@10:  * 
universe@10:  * Redistribution and use in source and binary forms, with or without
universe@10:  * modification, are permitted provided that the following conditions are met:
universe@10:  *
universe@10:  *   1. Redistributions of source code must retain the above copyright
universe@10:  *      notice, this list of conditions and the following disclaimer.
universe@10:  *
universe@10:  *   2. Redistributions in binary form must reproduce the above copyright
universe@10:  *      notice, this list of conditions and the following disclaimer in the
universe@10:  *      documentation and/or other materials provided with the distribution.
universe@10:  *
universe@10:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@10:  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@10:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@10:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@10:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@10:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@10:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@10:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@10:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@10:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@10:  * POSSIBILITY OF SUCH DAMAGE.
universe@10:  * 
universe@10:  */
universe@10: package de.uapcore.lightpit;
universe@10: 
universe@10: import java.util.ArrayList;
universe@10: import java.util.Collections;
universe@10: import java.util.List;
universe@10: 
universe@10: /**
universe@10:  * Maps a resource key for the menu label to the path name for the underlying
universe@10:  * site.
universe@10:  * 
universe@10:  * Objects of this class are internally instantiated by the
universe@10:  * {@link ModuleManager}.
universe@10:  */
universe@10: public class Menu extends MenuEntry {
universe@10:     
universe@10:     private final List<MenuEntry> entries = new ArrayList<>();
universe@10:     private final List<MenuEntry> immutableEntries = Collections.unmodifiableList(entries);
universe@10:     
universe@11:     /**
universe@11:      * Class name of the module for which this menu is built.
universe@11:      */
universe@11:     private String moduleClassName;
universe@11:     
universe@11:     
universe@10:     public Menu() {
universe@10:         super();
universe@10:     }
universe@10:     
universe@11:     public Menu(String moduleClassName, ResourceKey resourceKey, String pathName) {
universe@10:         super(resourceKey, pathName);
universe@11:         this.moduleClassName = moduleClassName;
universe@11:     }
universe@11:     
universe@11:     public void setModuleClassName(String moduleClassName) {
universe@11:         this.moduleClassName = moduleClassName;
universe@11:     }
universe@11: 
universe@11:     public String getModuleClassName() {
universe@11:         return moduleClassName;
universe@10:     }
universe@10: 
universe@10:     /**
universe@10:      * Sets a new list of menu entries for this menu.
universe@10:      * 
universe@10:      * @param entries the list of new menu entries
universe@10:      */
universe@10:     public void setEntries(List<MenuEntry> entries) {
universe@10:         // in case the given list is immutable, we copy the contents
universe@10:         this.entries.clear();
universe@10:         this.entries.addAll(entries);
universe@10:     }
universe@10: 
universe@10:     /**
universe@10:      * Retrieves an immutable list of menu entries for this menu.
universe@10:      * 
universe@10:      * @return the list of menu entries
universe@10:      */
universe@10:     public List<MenuEntry> getEntries() {
universe@10:         return immutableEntries;
universe@10:     }
universe@10:     
universe@10:     /**
universe@10:      * Adds a new menu entry to this menu.
universe@10:      * @param entry the menu entry to add
universe@10:      */
universe@10:     public void addMenuEntry(MenuEntry entry) {
universe@10:         entries.add(entry);
universe@10:     }
universe@10: }