src/main/java/de/uapcore/lightpit/MenuEntry.java

Fri, 22 May 2020 16:21:31 +0200

author
Mike Becker <universe@uap-core.de>
date
Fri, 22 May 2020 16:21:31 +0200
changeset 71
dca186d3911f
parent 70
821c4950b619
child 79
f64255a88d66
permissions
-rw-r--r--

adds breadcrumb menu

universe@10 1 /*
universe@10 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@34 3 *
universe@24 4 * Copyright 2018 Mike Becker. All rights reserved.
universe@34 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@34 27 *
universe@10 28 */
universe@10 29 package de.uapcore.lightpit;
universe@10 30
universe@36 31 import java.util.Objects;
universe@36 32
universe@10 33 /**
universe@10 34 * Maps a resource key for the menu label to the path name for the underlying
universe@10 35 * site.
universe@34 36 * <p>
universe@10 37 * Objects of this class are internally instantiated by the
universe@10 38 * {@link ModuleManager}.
universe@10 39 */
universe@36 40 public class MenuEntry implements Comparable<MenuEntry> {
universe@36 41
universe@36 42 /**
universe@11 43 * Resource key for the menu label.
universe@11 44 */
universe@36 45 private final ResourceKey resourceKey;
universe@34 46
universe@11 47 /**
universe@71 48 * Custom menu text.
universe@71 49 */
universe@71 50 private final String text;
universe@71 51
universe@71 52 /**
universe@11 53 * Path name of the module, linked by this menu entry.
universe@11 54 */
universe@36 55 private final String pathName;
universe@10 56
universe@36 57 /**
universe@36 58 * Sequence number to determine the ordering of the menu.
universe@36 59 */
universe@36 60 private final int sequence;
universe@36 61
universe@71 62 /**
universe@71 63 * True if this menu entry is active.
universe@71 64 */
universe@71 65 private boolean active = false;
universe@71 66
universe@45 67 public MenuEntry(ResourceKey resourceKey, String pathName, int sequence) {
universe@71 68 this.text = null;
universe@36 69 this.resourceKey = resourceKey;
universe@36 70 this.pathName = pathName;
universe@36 71 this.sequence = sequence;
universe@10 72 }
universe@10 73
universe@71 74 public MenuEntry(String text, String pathName, int sequence) {
universe@71 75 this.text = text;
universe@71 76 this.resourceKey = null;
universe@71 77 this.pathName = pathName;
universe@71 78 this.sequence = sequence;
universe@70 79 }
universe@70 80
universe@10 81 public ResourceKey getResourceKey() {
universe@10 82 return resourceKey;
universe@10 83 }
universe@10 84
universe@71 85 public String getText() {
universe@71 86 return text;
universe@71 87 }
universe@71 88
universe@10 89 public String getPathName() {
universe@10 90 return pathName;
universe@10 91 }
universe@34 92
universe@36 93 public int getSequence() {
universe@36 94 return sequence;
universe@36 95 }
universe@36 96
universe@71 97 public boolean isActive() {
universe@71 98 return this.active;
universe@71 99 }
universe@71 100
universe@71 101 public void setActive(boolean active) {
universe@71 102 this.active = true;
universe@71 103 }
universe@71 104
universe@36 105 @Override
universe@36 106 public boolean equals(Object o) {
universe@36 107 if (this == o) return true;
universe@36 108 if (o == null || getClass() != o.getClass()) return false;
universe@36 109 MenuEntry menuEntry = (MenuEntry) o;
universe@36 110 return resourceKey.equals(menuEntry.resourceKey) &&
universe@36 111 pathName.equals(menuEntry.pathName);
universe@36 112 }
universe@36 113
universe@36 114 @Override
universe@36 115 public int hashCode() {
universe@36 116 return Objects.hash(resourceKey, pathName);
universe@36 117 }
universe@36 118
universe@36 119 @Override
universe@36 120 public int compareTo(MenuEntry menuEntry) {
universe@36 121 return Integer.compare(this.sequence, menuEntry.sequence);
universe@36 122 }
universe@10 123 }

mercurial