/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.netbeans.lib.profiler.heap;
/**
* This represents one GC root. It has kind ({@link GCRoot#JNI_GLOBAL}, etc.) and also corresponding
* {@link Instance}, which is actual GC root.
* @author Tomas Hurka
*/
public interface GCRoot {
//~ Static fields/initializers -----------------------------------------------------------------------------------------------
/**
* JNI global GC root kind.
*/
public static final String JNI_GLOBAL = "JNI global"; // NOI18N
/**
* JNI local GC root kind.
*/
public static final String JNI_LOCAL = "JNI local"; // NOI18N
/**
* Java frame GC root kind.
*/
public static final String JAVA_FRAME = "Java frame"; // NOI18N
/**
* Native stack GC root kind.
*/
public static final String NATIVE_STACK = "native stack"; // NOI18N
/**
* Sticky class GC root kind.
*/
public static final String STICKY_CLASS = "sticky class"; // NOI18N
/**
* Thread block GC root kind.
*/
public static final String THREAD_BLOCK = "thread block"; // NOI18N
/**
* Monitor used GC root kind.
*/
public static final String MONITOR_USED = "monitor used"; // NOI18N
/**
* Thread object GC root kind.
*/
public static final String THREAD_OBJECT = "thread object"; // NOI18N
/**
* Unknown GC root kind.
*/
public static final String UNKNOWN = "unknown"; // NOI18N
//~ Methods ------------------------------------------------------------------------------------------------------------------
/**
* returns corresponding {@link Instance}, which is GC root.
* <br>
* Speed:normal
* @return GC root instance
*/
Instance getInstance();
/**
* returns kind of this GC root.
* <br>
* Speed:fast
* @return human readable GC root kind.
*/
String getKind();
}