core/api/src/main/java/org/onosproject/ui/UiView.java

/*
 * Copyright 2015-present Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.ui;

import com.google.common.base.MoreObjects;

import java.util.Objects;

/**
 * Represents a user interface view addition.
 */
public class UiView {

    private static final  String DEFAULT_HELP_PAGE_URL =
            "https://wiki.onosproject.org/display/ONOS/The+ONOS+Web+GUI";

    /**
     * Designates the navigation menu category.
     */
    public enum Category {
        // NOTE: human readable strings for the categories are now applied
        //       externally, with the appropriate localization bundle.
        /**
         * Represents platform related views.
         */
        PLATFORM,

        /**
         * Represents network-control related views.
         */
        NETWORK,

        /**
         * Represents miscellaneous views.
         */
        OTHER,

        /**
         * Represents views that do not show in the navigation menu.
         * This category should not be specified directly; rather, use
         * the {@link UiViewHidden} constructor instead of {@link UiView}.
         */
        HIDDEN
    }

    private final Category category;
    private final String id;
    private final String label;
    private final String iconId;
    private final String helpPageUrl;

    /**
     * Creates a new user interface view descriptor. The navigation item
     * will appear in the navigation menu under the specified category.
     *
     * @param category view category
     * @param id       view identifier
     * @param label    view label
     */
    public UiView(Category category, String id, String label) {
        this(category, id, label, null, null);
    }

    /**
     * Creates a new user interface view descriptor. The navigation item
     * will appear in the navigation menu under the specified category,
     * with the specified icon adornment.
     * <p>
     * Note: see the {@code glyphMapping} structure in {@code icon.js} for
     * valid icon identifiers.
     *
     * @param category view category
     * @param id       view identifier
     * @param label    view label
     * @param iconId   icon id
     */
    public UiView(Category category, String id, String label, String iconId) {
        this(category, id, label, iconId, null);
    }

    /**
     * Creates a new user interface view descriptor. The navigation item
     * will appear in the navigation menu under the specified category,
     * with the specified icon adornment and specified help page.
     * <p>
     * Note: see the {@code glyphMapping} structure in {@code icon.js} for
     * valid icon identifiers.
     *
     * @param category view category
     * @param id       view identifier
     * @param label    view label
     * @param iconId   icon id
     * @param helpPageUrl help page URL
     */
    public UiView(Category category, String id, String label, String iconId,
                  String helpPageUrl) {
        this.category = category;
        this.id = id;
        this.label = label;
        this.iconId = iconId;
        this.helpPageUrl = (helpPageUrl == null) ?
                DEFAULT_HELP_PAGE_URL : helpPageUrl;
    }

    /**
     * Returns the navigation category.
     *
     * @return navigation category
     */
    public Category category() {
        return category;
    }

    /**
     * Returns the view identifier.
     *
     * @return view ID
     */
    public String id() {
        return id;
    }

    /**
     * Returns the view label.
     *
     * @return view label
     */
    public String label() {
        return label;
    }

    /**
     * Returns the icon identifier.
     *
     * @return icon ID
     */
    public String iconId() {
        return iconId;
    }

    /**
     * Returns the help page URL for a specific view.
     *
     * @return help page URL
     */
    public String helpPageUrl() {
        return helpPageUrl;
    }

    @Override
    public int hashCode() {
        return id.hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        UiView other = (UiView) obj;
        return Objects.equals(this.id, other.id);
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                .add("category", category)
                .add("id", id)
                .add("label", label)
                .add("iconId", iconId)
                .toString();
    }
}