universe@10: /*
universe@10:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@34:  *
universe@24:  * Copyright 2018 Mike Becker. All rights reserved.
universe@34:  *
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@34:  *
universe@10:  */
universe@10: package de.uapcore.lightpit;
universe@10: 
universe@36: import java.util.Objects;
universe@36: 
universe@10: /**
universe@10:  * Maps a resource key for the menu label to the path name for the underlying
universe@10:  * site.
universe@34:  * <p>
universe@10:  * Objects of this class are internally instantiated by the
universe@10:  * {@link ModuleManager}.
universe@10:  */
universe@36: public class MenuEntry implements Comparable<MenuEntry> {
universe@36: 
universe@36:     /**
universe@36:      * Class name of the module for which this menu is built.
universe@36:      */
universe@36:     private final String moduleClassName;
universe@34: 
universe@11:     /**
universe@11:      * Resource key for the menu label.
universe@11:      */
universe@36:     private final ResourceKey resourceKey;
universe@34: 
universe@11:     /**
universe@11:      * Path name of the module, linked by this menu entry.
universe@11:      */
universe@36:     private final String pathName;
universe@10: 
universe@36:     /**
universe@36:      * Sequence number to determine the ordering of the menu.
universe@36:      */
universe@36:     private final int sequence;
universe@36: 
universe@36:     public MenuEntry(String moduleClassName, ResourceKey resourceKey, String pathName, int sequence) {
universe@36:         this.moduleClassName = moduleClassName;
universe@36:         this.resourceKey = resourceKey;
universe@36:         this.pathName = pathName;
universe@36:         this.sequence = sequence;
universe@10:     }
universe@10: 
universe@36:     public String getModuleClassName() {
universe@36:         return moduleClassName;
universe@10:     }
universe@10: 
universe@10:     public ResourceKey getResourceKey() {
universe@10:         return resourceKey;
universe@10:     }
universe@10: 
universe@10:     public String getPathName() {
universe@10:         return pathName;
universe@10:     }
universe@34: 
universe@36:     public int getSequence() {
universe@36:         return sequence;
universe@36:     }
universe@36: 
universe@36:     @Override
universe@36:     public boolean equals(Object o) {
universe@36:         if (this == o) return true;
universe@36:         if (o == null || getClass() != o.getClass()) return false;
universe@36:         MenuEntry menuEntry = (MenuEntry) o;
universe@36:         return resourceKey.equals(menuEntry.resourceKey) &&
universe@36:                 pathName.equals(menuEntry.pathName);
universe@36:     }
universe@36: 
universe@36:     @Override
universe@36:     public int hashCode() {
universe@36:         return Objects.hash(resourceKey, pathName);
universe@36:     }
universe@36: 
universe@36:     @Override
universe@36:     public int compareTo(MenuEntry menuEntry) {
universe@36:         return Integer.compare(this.sequence, menuEntry.sequence);
universe@36:     }
universe@10: }