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

Sat, 16 Dec 2017 20:19:28 +0100

author
Mike Becker <universe@uap-core.de>
date
Sat, 16 Dec 2017 20:19:28 +0100
changeset 10
89e3e6e28b69
child 11
737ab27e37b3
permissions
-rw-r--r--

implements automatic menu generation from module information

     1 /*
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  * 
     4  * Copyright 2017 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;
    31 import java.util.ArrayList;
    32 import java.util.Collections;
    33 import java.util.List;
    35 /**
    36  * Maps a resource key for the menu label to the path name for the underlying
    37  * site.
    38  * 
    39  * Objects of this class are internally instantiated by the
    40  * {@link ModuleManager}.
    41  */
    42 public class Menu extends MenuEntry {
    44     private final List<MenuEntry> entries = new ArrayList<>();
    45     private final List<MenuEntry> immutableEntries = Collections.unmodifiableList(entries);
    47     public Menu() {
    48         super();
    49     }
    51     public Menu(ResourceKey resourceKey, String pathName) {
    52         super(resourceKey, pathName);
    53     }
    55     /**
    56      * Sets a new list of menu entries for this menu.
    57      * 
    58      * @param entries the list of new menu entries
    59      */
    60     public void setEntries(List<MenuEntry> entries) {
    61         // in case the given list is immutable, we copy the contents
    62         this.entries.clear();
    63         this.entries.addAll(entries);
    64     }
    66     /**
    67      * Retrieves an immutable list of menu entries for this menu.
    68      * 
    69      * @return the list of menu entries
    70      */
    71     public List<MenuEntry> getEntries() {
    72         return immutableEntries;
    73     }
    75     /**
    76      * Adds a new menu entry to this menu.
    77      * @param entry the menu entry to add
    78      */
    79     public void addMenuEntry(MenuEntry entry) {
    80         entries.add(entry);
    81     }
    82 }

mercurial