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: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.insane.live;
043:
044: import java.util.Collection;
045: import java.util.Map;
046: import java.util.Set;
047: import javax.swing.BoundedRangeModel;
048:
049: import org.netbeans.insane.impl.LiveEngine;
050: import org.netbeans.insane.scanner.Filter;
051:
052: /**
053: * A live references engine entry point.
054: * Provides a means for tracing root-paths of given heap objects.
055: *
056: * @author nenik
057: */
058: public final class LiveReferences {
059:
060: /**
061: * Traces the heap from known roots until all of the objects in
062: * <code>objs</code> are found or all of the reachable heap is covered.
063: * This call is highly time consuming and can block all of the application,
064: * so it is mostly useful for debugging and runtime field analysis.
065: *
066: * @param objs a Collection of objects to trace
067: * @return a map with one entry for each found object that maps from
068: * the object to a {@link Path} instance.
069: */
070: public static Map<Object, Path> fromRoots(Collection<Object> objs) {
071: return new LiveEngine().trace(objs, null);
072: }
073:
074: /**
075: * Traces the heap from known roots until all of the objects in
076: * <code>objs</code> are found or all of the reachable heap is covered.
077: * This call is highly time consuming and can block all of the application,
078: * so it is mostly useful for debugging and runtime field analysis.
079: * This variant allows approximate tracking of the scan progress,
080: * but for real visual feedback, paintImmediatelly might be necessary.
081: *
082: * @param objs a Collection of objects to trace
083: * @param rootsHint a set of Object that should be considered roots. Can be null.
084: * @param progress a model of a ProgressBar to be notified during the scan. Can be null.
085: * @return a map with one entry for each found object that maps from
086: * the object to a {@link Path} instance.
087: *
088: */
089: public static Map<Object, Path> fromRoots(Collection<Object> objs,
090: Set<Object> rootsHint, BoundedRangeModel progress) {
091: return new LiveEngine(progress).trace(objs, rootsHint);
092: }
093:
094: /**
095: * Traces the heap from known roots until all of the objects in
096: * <code>objs</code> are found or all of the reachable heap is covered.
097: * This call is highly time consuming and can block all of the application,
098: * so it is mostly useful for debugging and runtime field analysis.
099: * This variant allows approximate tracking of the scan progress,
100: * but for real visual feedback, paintImmediatelly might be necessary.
101: *
102: * @param objs a Collection of objects to trace
103: * @param rootsHint a set of Object that should be considered roots. Can be null.
104: * @param progress a model of a ProgressBar to be notified during the scan. Can be null.
105: * @param f the {@link Filter} to apply on heap's live objects.
106: * @return a map with one entry for each found object that maps from
107: * the object to a {@link Path} instance.
108: *
109: */
110: public static Map<Object, Path> fromRoots(Collection<Object> objs,
111: Set<Object> rootsHint, BoundedRangeModel progress, Filter f) {
112: return new LiveEngine(progress, f).trace(objs, rootsHint);
113: }
114:
115: /** No instances */
116: private LiveReferences() {
117: }
118: }
|