LightPIT: src/main/java/de/uapcore/lightpit/MenuEntry.java@dca186d3911f

     1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

     3  *

     4  * Copyright 2018 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.Objects;

    33 /**

    34  * Maps a resource key for the menu label to the path name for the underlying

    35  * site.

    36  * <p>

    37  * Objects of this class are internally instantiated by the

    38  * {@link ModuleManager}.

    39  */

    40 public class MenuEntry implements Comparable<MenuEntry> {

    42     /**

    43      * Resource key for the menu label.

    44      */

    45     private final ResourceKey resourceKey;

    47     /**

    48      * Custom menu text.

    49      */

    50     private final String text;

    52     /**

    53      * Path name of the module, linked by this menu entry.

    54      */

    55     private final String pathName;

    57     /**

    58      * Sequence number to determine the ordering of the menu.

    59      */

    60     private final int sequence;

    62     /**

    63      * True if this menu entry is active.

    64      */

    65     private boolean active = false;

    67     public MenuEntry(ResourceKey resourceKey, String pathName, int sequence) {

    68         this.text = null;

    69         this.resourceKey = resourceKey;

    70         this.pathName = pathName;

    71         this.sequence = sequence;

    72     }

    74     public MenuEntry(String text, String pathName, int sequence) {

    75         this.text = text;

    76         this.resourceKey = null;

    77         this.pathName = pathName;

    78         this.sequence = sequence;

    79     }

    81     public ResourceKey getResourceKey() {

    82         return resourceKey;

    83     }

    85     public String getText() {

    86         return text;

    87     }

    89     public String getPathName() {

    90         return pathName;

    91     }

    93     public int getSequence() {

    94         return sequence;

    95     }

    97     public boolean isActive() {

    98         return this.active;

    99     }

   101     public void setActive(boolean active) {

   102         this.active = true;

   103     }

   105     @Override

   106     public boolean equals(Object o) {

   107         if (this == o) return true;

   108         if (o == null || getClass() != o.getClass()) return false;

   109         MenuEntry menuEntry = (MenuEntry) o;

   110         return resourceKey.equals(menuEntry.resourceKey) &&

   111                 pathName.equals(menuEntry.pathName);

   112     }

   114     @Override

   115     public int hashCode() {

   116         return Objects.hash(resourceKey, pathName);

   117     }

   119     @Override

   120     public int compareTo(MenuEntry menuEntry) {

   121         return Integer.compare(this.sequence, menuEntry.sequence);

   122     }

   123 }

Mercurial > hg > LightPIT / file revision