001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: * The Original Software is NetBeans. The Initial Developer of the Original
026: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
027: * Microsystems, Inc. All Rights Reserved.
028: *
029: * If you wish your version of this file to be governed by only the CDDL
030: * or only the GPL Version 2, indicate your decision by adding
031: * "[Contributor] elects to include this software in this distribution
032: * under the [CDDL or GPL Version 2] license." If you do not indicate a
033: * single choice of license, a recipient has the option to distribute
034: * your version of this file under either the CDDL, the GPL Version 2 or
035: * to extend the choice of license to its licensees as provided above.
036: * However, if you add GPL Version 2 code and therefore, elected the GPL
037: * Version 2 license, then the option applies only if the new code is
038: * made subject to such option by the copyright holder.
039: */
040:
041: package org.netbeans.lib.profiler.heap;
042:
043: /**
044: * This represents one GC root. It has kind ({@link GCRoot#JNI_GLOBAL}, etc.) and also corresponding
045: * {@link Instance}, which is actual GC root.
046: * @author Tomas Hurka
047: */
048: public interface GCRoot {
049: //~ Static fields/initializers -----------------------------------------------------------------------------------------------
050:
051: /**
052: * JNI global GC root kind.
053: */
054: public static final String JNI_GLOBAL = "JNI global"; // NOI18N
055:
056: /**
057: * JNI local GC root kind.
058: */
059: public static final String JNI_LOCAL = "JNI local"; // NOI18N
060:
061: /**
062: * Java frame GC root kind.
063: */
064: public static final String JAVA_FRAME = "Java frame"; // NOI18N
065:
066: /**
067: * Native stack GC root kind.
068: */
069: public static final String NATIVE_STACK = "native stack"; // NOI18N
070:
071: /**
072: * Sticky class GC root kind.
073: */
074: public static final String STICKY_CLASS = "sticky class"; // NOI18N
075:
076: /**
077: * Thread block GC root kind.
078: */
079: public static final String THREAD_BLOCK = "thread block"; // NOI18N
080:
081: /**
082: * Monitor used GC root kind.
083: */
084: public static final String MONITOR_USED = "monitor used"; // NOI18N
085:
086: /**
087: * Thread object GC root kind.
088: */
089: public static final String THREAD_OBJECT = "thread object"; // NOI18N
090:
091: /**
092: * Unknown GC root kind.
093: */
094: public static final String UNKNOWN = "unknown"; // NOI18N
095:
096: //~ Methods ------------------------------------------------------------------------------------------------------------------
097:
098: /**
099: * returns corresponding {@link Instance}, which is GC root.
100: * <br>
101: * Speed:normal
102: * @return GC root instance
103: */
104: Instance getInstance();
105:
106: /**
107: * returns kind of this GC root.
108: * <br>
109: * Speed:fast
110: * @return human readable GC root kind.
111: */
112: String getKind();
113: }
|