/*
 * Copyright (c) 2007, 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.max.ins.view;

import java.util.*;

import com.sun.max.ins.*;
import com.sun.max.ins.gui.*;
import com.sun.max.ins.view.InspectionViews.ViewKind;


/**
 * A manager for a specific kind of Inspector View, each instance
 * of which is implemented as a subclass of {@link AbstractView}.  Some kinds
 * of views are singletons, others may have an unbounded number of
 * instances. The intention is that there be a singleton manager for
 * each kind of view.
 * <p>
 * The manager is both a source of meta-information about the kind
 * of view, and an implementation that manages the view(s).
 */
public interface ViewManager<Inspector_Kind extends InspectorView>  {

    /**
     * @return the kind of view being managed by this manager
     */
    ViewKind viewKind();

    /**
     * @return terse name of this view, typically just what's being viewed, e.g. "Threads"
     */
    String shortName();

    /**
     * @return full name of this view, e.g. "Threads Inspector"
     */
    String longName();

    /**
     * @return whether there can only be one instance of this kind of view.
     */
    boolean isSingleton();

    /**
     * Determines whether this kind of view is supported by currently
     * running configuration and platform.
     *
     * @return whether this kind view is
     */
    boolean isSupported();

    /**
     * Determines whether this kind of view can be created under the current circumstances.
     * Implies {@link #isSupported()}.
     *
     * @return whether it is possible to create this kind of view
     */
    boolean isEnabled();

    /**
     * Determines whether one or more views of this kind are currently active.
     * Implies {@link #isEnabled()}.
     *
     * @return whether views are currently active
     */
    boolean isActive();

    /**
     * @return all active views being managed by this manager.
     */
    List<Inspector_Kind> activeViews();

    /**
     * Gets an action for deactivating all views being managed by this manager,
     * possibly excepting a single view.
     *
     * @param exceptInspector a view that should not be deactivated
     * @return the action for deactivating views being managed by this manager
     */
    InspectorAction deactivateAllAction(InspectorView exceptInspector);

}