/*
 * Copyright (c) 2011, 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.object;

import com.sun.max.ins.*;
import com.sun.max.ins.view.*;
import com.sun.max.tele.*;


/**
 * Methods for creating views on objects in different variations.  Some are direct
 * actions; others are for possibly interactive {@link InspectorAction}s
 * that can be put on menus.
 */
public interface ObjectViewFactory extends InspectionViewFactory<ObjectView>{

    /**
     * Gets a view on a specified object in VM memory, either an already existing view
     * if one exits for that object, or a newly created view.
     *
     * @param object the VM object to be viewed
     * @return an object view
     */
    ObjectView makeView(MaxObject object);

    /**
     * Gets an interactive action that makes a view on an object in
     * VM memory, starting at a dialog-specified location.
     *
     * @return an action that creates an object view
     */
    InspectorAction makeViewByAddressAction();

    /**
     * Gets an interactive action that makes a view on an object in
     * VM memory, identified by a dialog-specified numeric ID.
     *
     * @return an action that creates an object view
     */
    InspectorAction makeViewByIDAction();

    /**
     * Gets an action that closes all views on objects and quasi-objects
     * whose status is {@linkplain ObjectStatus#DEAD DEAD}.
     *
     * @return an action that closes views on dead objects.
     */
    InspectorAction makeCloseDeadViewsAction();

    /**
     * Gets an action that makes a view on a specified object in
     * VM memory.
     *
     * @param object the VM object that would be viewed
     * @param actionTitle a string to be used if the action is in a menu, default title used if null
     * @return an action that creates an object view
     */
    InspectorAction makeViewAction(MaxObject object, String actionTitle);

}