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

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2018 Mike Becker. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */
package de.uapcore.lightpit;

import java.util.Objects;

/**
 * Maps a resource key for the menu label to the path name for the underlying
 * site.
 * <p>
 * Objects of this class are internally instantiated by the
 * {@link ModuleManager}.
 */
public class MenuEntry implements Comparable<MenuEntry> {

    /**
     * Resource key for the menu label.
     */
    private final ResourceKey resourceKey;

    /**
     * Custom menu text.
     */
    private final String text;

    /**
     * Path name of the module, linked by this menu entry.
     */
    private final String pathName;

    /**
     * Sequence number to determine the ordering of the menu.
     */
    private final int sequence;

    /**
     * True if this menu entry is active.
     */
    private boolean active = false;

    public MenuEntry(ResourceKey resourceKey, String pathName, int sequence) {
        this.text = null;
        this.resourceKey = resourceKey;
        this.pathName = pathName;
        this.sequence = sequence;
    }

    public MenuEntry(String text, String pathName, int sequence) {
        this.text = text;
        this.resourceKey = null;
        this.pathName = pathName;
        this.sequence = sequence;
    }

    public ResourceKey getResourceKey() {
        return resourceKey;
    }

    public String getText() {
        return text;
    }

    public String getPathName() {
        return pathName;
    }

    public int getSequence() {
        return sequence;
    }

    public boolean isActive() {
        return this.active;
    }

    public void setActive(boolean active) {
        this.active = true;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        MenuEntry menuEntry = (MenuEntry) o;
        return resourceKey.equals(menuEntry.resourceKey) &&
                pathName.equals(menuEntry.pathName);
    }

    @Override
    public int hashCode() {
        return Objects.hash(resourceKey, pathName);
    }

    @Override
    public int compareTo(MenuEntry menuEntry) {
        return Integer.compare(this.sequence, menuEntry.sequence);
    }
}