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

import java.util.*;

import com.sun.max.vm.*;


/**
 *  Remote inspection support for a particular {@link VMScheme} in the VM.
 *
 *  @see VMScheme
 */
public interface RemoteScheme {

    /**
     * @return the specific scheme being supported
     */
    Class schemeClass();

    /**
     * Identifies methods specific to a particular scheme implementation in the VM, which
     * can be presented to the user, for example to set predefined breakpoints.
     *
     * @return descriptions of methods unique to a specific scheme implementation.
     */
    List<MaxCodeLocation> inspectableMethods();

    /**
     * Identifies objects specific to a particular scheme implementation in the VM, which
     * a user might find helpful to view.
     *
     * @return descriptions of objects unique to a specific scheme implementation.
     */
    List<MaxObject> inspectableObjects();

}